Subscribe to a plan; amount and interval come from the catalog
Subscribes the calling consumer to a published plan.
/v1/explore/offerings/{offeringId}/subscribeSubscribes the calling consumer to a published plan. Amount and interval come from the catalog, and the marketplace commission is fixed at signup so a later rate change cannot move a mandate somebody agreed to. Requires subscriptions:write, an Idempotency-Key and a consumer token (consumer_token_required, 403). Refuses offering_not_found (404), not_a_plan (422) for an item — use purchase — invalid_request (400), and idempotency_key_reuse (409).
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidHeader Parameters
1 <= length <= 200Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/explore/offerings/497f6eca-6276-4993-bfeb-53cbbbba6f08/subscribe" \ -H "Idempotency-Key: string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "plan_name": "string", "amount": 0, "commission": 0, "interval": "weekly", "status": "active", "next_charge_at": "2019-08-24T14:15:22Z", "retry_count": 0, "metadata": { "property1": "string", "property2": "string" }, "created_at": "2019-08-24T14:15:22Z"}Buy a one-off item; the catalog price is the only price
Buys one unit of a published item for the calling consumer.
The client's payout statement, newest first
The client's payout statement, newest first, each row with the amount that left settlement, the fee the wallet kept, the rail and the ledger transaction behind it.