Authorizations
To authenticate against the API, use HTTP Basic Authentication with your customer ID as the username and API key as the password.
Path Parameters
Body
Pass in anything you want here. You can use this to tie an account back to an internal ID or track other data
If a Stripe customer ID already exists for this account, pass it in here, otherwise we'll make one.
Attach account to a plan. This will create all appropriate treasury balances for that plan on the account and start billing them for the plan immediately.
If the plan does have a charge, then the account must have payment information or the call will fail.
If you call with enable_card_collector
then the plan
won't be attached until the user fills out their payment information on the form.
If the plan supports variable billing where you can change the amount of a given balance which changes the amount billed, then you can use this object to specify what those amounts are.
Example:
"plan_variable_amounts": {
"credits": 100,
"seats": 5
},
Generate a URL that can be used to attach payment method to account. This URL will come back in the response
Response
Accounts are the customers of Companies. They are what are actually generating events and being billed
{
"id": "string",
"name": "string",
"email": "string",
"company_id": "string",
"plan_id": "string",
"plan_renewal_cadence": "string",
"stripe_id": "string",
"created_at": "string",
"updated_at": "string",
"metadata": {},
"last_plan_renewal": "2019-08-24T14:15:22Z",
"next_plan_renewal": "2019-08-24T14:15:22Z",
"plan_status": "string",
"flags": [{}]
}