List products
Paginated active products of your account, newest first, 20 per page by default and 100 at most (`page`, `page_size`), each with its plans and visible billing periods. Use a billing period's `pbp_id` to create a subscription, and its `interval_type` to tell a recurring plan from a one-time purchase before you offer cancel or resume on it.
Authorization
ApiKey API key issued to the partner, sent with the Bearer prefix — for example: Authorization: Bearer su_key_9f2c4d1ab3….
Keys minted on the live instance are prefixed su_key_ and keys minted on sandbox su_test_key_. The two instances keep separate key tables and separate hosts, so a sandbox key sent to the live host — or the reverse — answers Invalid API key. rather than falling back to the other environment.
In: header
Query Parameters
A page number within the paginated result set.
Number of results to return per page.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/products/"{ "count": 0, "next": "http://example.com", "previous": "http://example.com", "results": [ { "product_id": "string", "name": "string", "description": "string", "type": "simple", "is_active": true, "terms_and_conditions": "string", "features_and_benefits": "string", "vat": { "is_vat_active": true, "vat_type": "inclusive", "vat_percentage": 0 }, "product_image": [ { "image": "http://example.com", "image_order": 0 } ], "plan": [ { "plan_id": "string", "plan_name": "string", "description": "string", "billing_periods": [ { "pbp_id": "string", "interval_type": "day", "interval_count": 0, "label": "string", "price": "string", "currency": "str", "is_current": true, "is_limited": true, "is_archived": true, "offers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "discount_amount": 0, "starts_at": "2019-08-24", "valid_until": "2019-08-24", "is_active": true } ] } ] } ], "total_subscribers": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ]}Update a customer PATCH
Correct your account's copy of a customer's name, email or address. Send only the fields you are changing; `""` clears a field. The phone identifies the buyer and cannot be changed. `email` reads back as `buyer_email`.
Renew a subscription POST
Open a checkout session for the next payment on one of your own subscriptions, using its existing customer and billing period (or inline item) rather than resubmitting them. Send the returned `checkout_url` to the buyer to collect payment. A cancelled or archived subscription, or a paid one-time purchase, cannot be renewed.