CRUD Billing Plans

The following endpoints can be used to maintain billing plans.

Create billing plan

All billing plans should be created on Stripe; they will automatically be synced with the portal.

Retrieve billing plans

You can use the following endpoint within your custom pages in order to get all available billing plans. The plans should be set up through Stripe before using this endpoint.

Summary

  • Endpoint: /api/v2/billing_available_plans
  • Method: GET
  • Required User Type: TA

Response

A successful response will return an array of objects.

Each of the objects represents a different billing plan 

Example

Request

/api/v2/billing_available_plans 

Response Data

[
{
currency"usd",
amountnull,
id: "price_1H2fHrD2ofij23fijg1sd",
interval: "year",
interval_count1
metadata{}
name: "test plan"
statement_descriptor: null
...
}
]

 

Update billing plan

All billing plans should be update on Stripe; they will automatically be synced with the portal.

 

Delete billing plan

All billing plans should be deleted/archived on Stripe; this will automatically be synced with the portal.