API by router
Customers
GET
HTTPBearerheader
AuthorizationBearer <token>page?PagePage number
Range
1 <= valueDefault
1per_page?Per PageItems per page
Range
1 <= value <= 100Default
20search?SearchSearch by email
Default
""sort_by?Sort BySort field
Default
"created_at"sort_dir?Sort DirSort direction: asc or desc
Default
"desc"X-Api-Key?string|nullSuccessful Response
application/json- response
Paginated customer list response. "Here's looking at you, kid." - Rick Blaine, Casablanca
customers*array<>page*Pageper_page*Per Pagetotal*Totaltotal_pages*Total Pagescurl -X GET 'https://example.com/v1/customers'Example Response
{ "customers": [ { "active_subscription_count": 0, "company_name": "string", "country_code": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "email": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_count": 0, "latest_subscription_status": "string", "running_instance_count": 0, "subscription_count": 0, "timezone": "string" } ], "page": 0, "per_page": 0, "total": 0, "total_pages": 0}POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
Create a new end-customer for the tenant.
company_name?string|nullcountry_code?string|nullcurrency?string|nullemail?string|nullindustry?string|nulllocale?string|nulltimezone?string|nullSuccessful Response
application/json- response
company_name?string|nullcreated_at*Created AtFormat
date-timeemail?string|nullid*IdFormat
uuidcurl -X POST 'https://example.com/v1/customers' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "company_name": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}GET
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Extended customer detail with subscriptions and instances. "Show me the money!" — Rod Tidwell, Jerry Maguire
active_subscription_count?Active Subscription CountDefault
0company_name?string|nullcountry_code?string|nullcreated_at*Created AtFormat
date-timecurrency?string|nullemail?string|nullid*IdFormat
uuidinstance_count?Instance CountDefault
0instances?array<>Default
[]latest_subscription_status?string|nulllocale?string|nullrunning_instance_count?Running Instance CountDefault
0stripe_customer_id?string|nullsubscription_count?Subscription CountDefault
0subscriptions?array<>Default
[]timezone?string|nullupdated_at*Updated AtFormat
date-timecurl -X GET 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "active_subscription_count": 0, "company_name": "string", "country_code": "string", "created_at": "2019-08-24T14:15:22Z", "currency": "string", "email": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_count": 0, "instances": [], "latest_subscription_status": "string", "locale": "string", "running_instance_count": 0, "stripe_customer_id": "string", "subscription_count": 0, "subscriptions": [], "timezone": "string", "updated_at": "2019-08-24T14:15:22Z"}POST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullapplication/json- body
clone_rules?Clone RulesDefault
truecompany_name*Company NameLength
length <= 200email?string|nullsource_customer_id*Source Customer IdFormat
uuidSuccessful Response
application/json- response
company_name?string|nullcreated_at*Created AtFormat
date-timeemail?string|nullid*IdFormat
uuidcurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/clone' \ -H 'Content-Type: application/json' \ -d '{ "company_name": "string", "source_customer_id": "22f9e5e1-5129-4cc7-9d8d-1248b092e05b"}'Example Response
{ "company_name": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}