Billing
/billing/providerhook
Webhooks
/billing/plans
Get plan listing
/team/:teamid/billing/permissions
Get a teams plan permissions list
teamid: The id of the team to act on
/team/:teamid/plans (authenticated)
Get all plans available for a team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
integer page: The desired page
integer pageSize: The desired page size
teamid: The id of the team to act on
/plans
Get all plans
integer page: The desired page
integer pageSize: The desired page size
/team/:teamid/subscription/summary
Get the subscription summary
teamid: The id of the team to act on
/team/:teamid/subscriptions (authenticated)
Get all subscriptions for a team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
integer page: The desired page
integer pageSize: The desired page size
teamid: The id of the team to act on
/team/:teamid/subscription/active (authenticated)
Get the active subscription for a team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
teamid: The id of the team to act on
/team/:teamid/billing/info (authenticated)
Get billing info
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
teamid: The id of the team to act on
/coupon/:couponcode
Lookup coupon code
couponcode: undocumented
/team/:teamid/billing/info/:token (authenticated)
Update billing info
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
{
// The billing contact name
first_name: string,
//
last_name: string,
//
address1: string,
//
address2: string,
//
city: string,
//
state: string,
//
postal_code: string,
//
phone: string,
//
country: string,
//
email: string,
//
card_type: string,
//
last_four_digits: string,
//
expires: string,
// (Optional)
three_d_secure_token: string,
}
teamid: The id of the team to act on
token: undocumented
/team/:teamid/subscribe/:planid (authenticated)
Subscribe a team to a plan
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
{
// A coupon code
coupon_code: string,
}
teamid: The id of the team to act on
planid: undocumented
/team/:teamid/subscription/cancel/pending (authenticated)
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
teamid: The id of the team to act on
/team/:teamid/subscription/cancel (authenticated)
Cancel active subscription
Should turn off renewal on the subscription.
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
teamid: The id of the team to act on
/team/:teamid/billing/accountid (authenticated)
Get the account id for a team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
teamid: The id of the team to act on
/team/:teamid/billing/adjustments (authenticated)
Get all adjustments records for a team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
teamid: The id of the team to act on
/team/:teamid/billing/coupon (authenticated)
Redeem a coupon code for an account
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
{
// The coupon code
coupon_code: string,
}
teamid: The id of the team to act on
/team/:teamid/invoice/:invoice (authenticated)
Download Invoice
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- team_management
teamid: The id of the team to act on
invoice: undocumented