/
Register account

Register account

Request

Register account.

Security
PublishableApiKey
Bodyapplication/json
usernamestringrequired

Username.

passwordstring, (password)required

Password.

primaryAddressobject(ContactObject)

Contact's information.

paymentTokenstring

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

leadSourceobject(LeadSourceData)

Lead source information.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/storefront/register \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json'

Responses

Account registered.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 characters(ResourceId)read-only

ID of the account.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
websiteIdstring, <= 50 characters(WebsiteId)read-only

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
usernamestringread-only

Username associated with the account.

primaryAddressobject(ContactObject)

Contact's information.

defaultPaymentInstrumentobject or nullread-only

Default payment instrument of the customer.

The default payment instrument is used to automatically pay subscription renewals, and for transaction requests where a specific payment instrument is not provided.

preferredPayoutInstrumentIdstring or null, <= 50 characters

ID of the customer's preferred payment instrument for payouts.

Default:null
Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"
isVerifiedbooleanread-only

Verification status of the email address associated with the account.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

taxNumbersArray of objects or null(TaxNumber)

Tax numbers associated with the account.

notificationEmailsArray of strings, (email)

Email addresses for notification delivery in event-based email notifications. When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify. For more information, see Manage notification emails.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "username": "string",
  "primaryAddress": {
    "firstName": "Benjamin",
    "lastName": "Franklin",
    "organization": "Rebilly",
    "address": "36 Craven St",
    "address2": "string",
    "city": "Austin",
    "region": "Texas",
    "country": "GB",
    "postalCode": "WC2N 5NF",
    "phoneNumbers": [ … ],
    "emails": [ … ],
    "dob": "1980-04-01",
    "jobTitle": "CEO",
    "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
  },
  "defaultPaymentInstrument": {
    "method": "payment-card",
    "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
  },
  "preferredPayoutInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
  "isVerified": true,
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "taxNumbers": [
    { … }
  ],
  "notificationEmails": [
    "user@example.com"
  ],
  "_links": [
    { … }
  ],
  "_embedded": {
    "website": {},
    "leadSource": {}
  }
}