Account

An account in which you are subscribed to in order to use the Rebilly product.

Retrieve Account

Retrieve account.

SecurityCustomerJWT

Responses

200

Account was retrieved successfully.

Response Schema: application/json

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

username

string

Username.

object (ContactObject)

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash

string <= 40 characters

A hash that can be used to compare multiple contacts for identical attribute values.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/account

Request samples

curl -i -X GET \
  https://api-sandbox.rebilly.com/storefront/account \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"username": "string",
"primaryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"defaultPaymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"customFields": {"foo": "bar"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}

Update Account

SecurityCustomerJWT

Request

Request Body schema: application/json

object (ContactObject)

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

paymentToken

string

A write-only payment token; if supplied, it will be converted into a payment instrument and be set as the defaultPaymentInstrument. The value of this property will override the defaultPaymentInstrument in the case that both are supplied. The token may only be used once before it is expired.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

Responses

200

Account updated.

Response Schema: application/json

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

username

string

Username.

object (ContactObject)

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash

string <= 40 characters

A hash that can be used to compare multiple contacts for identical attribute values.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

patch/account

Request samples

application/json

{"primaryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO"
},
"paymentToken": "string",
"defaultPaymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"customFields": {"foo": "bar"
}
}

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"username": "string",
"primaryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"defaultPaymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"customFields": {"foo": "bar"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}

Change Account password

Change account password.

SecurityCustomerJWT

Request

Request Body schema: application/json

currentPassword required	string <password> Current password - used when requesting password change.
newPassword required	string <password> New password - used when requesting password change.

Responses

200

Account password updated.

Response Schema: application/json

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

username

string

Username.

object (ContactObject)

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash

string <= 40 characters

A hash that can be used to compare multiple contacts for identical attribute values.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

patch/account/password

Request samples

application/json

{"currentPassword": "pa$$word",
"newPassword": "pa$$word"
}

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"username": "string",
"primaryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"defaultPaymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"customFields": {"foo": "bar"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}

Register Account

SecurityPublishableApiKey

Request

Request Body schema: application/json

username

required

string

Username.

password

required

string <password>

Password.

object (ContactObject)

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

paymentToken

string

object (LeadSourceData)

medium	string Lead source medium (eg search, display).
source	string Lead source origin (eg google, yahoo).
campaign	string Lead source campaign (eg go-big-123).
term	string Lead source term (eg salt shakers).
content	string Lead source content (eg smiley faces).
affiliate	string Lead source affiliate (eg 123, Bob Smith).
subAffiliate	string Lead source sub-affiliate also called a sub-id or click id in some circles (eg 123456).
salesAgent	string Lead source sales agent (eg James Bond).
clickId	string Lead source click id (may come from an ad server).
path	string Lead source path url (eg www.example.com/some/landing/path).
referrer	string Lead source `referer` url as determined (eg www.example.com/some/landing/path).

Responses

201

Account registered.

Response Schema: application/json

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

username

string

Username.

object (ContactObject)

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash

string <= 40 characters

A hash that can be used to compare multiple contacts for identical attribute values.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/register

Request samples

application/json

null

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"username": "string",
"primaryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"defaultPaymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"customFields": {"foo": "bar"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [{"rel": "self",
"href": "string"
}
]
}

➔ Next to Authentication