Get a billing plan

GET

https://app.resemble.ai/billing/api/v1/plans/:id

GET

/billing/api/v1/plans/:id

$ curl https://app.resemble.ai/billing/api/v1/plans/flex

1 {
2   "plan": {
3     "id": 1,
4     "name": "string",
5     "slug": "string",
6     "plan_type": "self_serve",
7     "base_fee_cents": 1,
8     "base_fee_dollars": 1.1,
9     "total_base_cost_cents": 1,
10     "total_base_cost_dollars": 1.1,
11     "included_dollar_balance_cents": 1,
12     "included_dollar_balance_dollars": 1.1,
13     "billing_interval": "monthly",
14     "plan_family": {
15       "key": "string",
16       "name": "string",
17       "description": "string",
18       "position": 1
19     },
20     "active": true,
21     "products": [
22       {
23         "id": 1,
24         "name": "string",
25         "slug": "string",
26         "description": "string",
27         "unit_type": "string",
28         "category": "metered",
29         "rate_per_unit_cents": 1,
30         "rate_per_unit_dollars": 1.1,
31         "has_tiers": true,
32         "tiers": [
33           {
34             "tier_order": 1,
35             "min_quantity": 1.1,
36             "max_quantity": 1.1,
37             "rate_per_unit_cents": 1,
38             "rate_per_unit_dollars": 1.1
39           }
40         ],
41         "included_quantity": 1.1,
42         "allow_additional_usage": true,
43         "min_usage_per_period": 1.1,
44         "max_usage_per_period": 1.1,
45         "ui_visible": true,
46         "product_family": {
47           "key": "string",
48           "name": "string",
49           "description": "string",
50           "position": 1
51         }
52       }
53     ],
54     "created_at": "2024-01-15T09:30:00Z",
55     "updated_at": "2024-01-15T09:30:00Z"
56   }
57 }

Returns an active billing plan by slug, including its products, prices, and quantity rules. This endpoint is public.

Path parameters

idstringRequired

Plan slug returned by the list-plans endpoint.

Response

Billing plan details.

planobject

Errors

404

Not Found Error

500

Internal Server Error