Subscriptions

Build recurring billing with account-scoped APIs. Legacy merchant subscription endpoints are not supported.

  1. GET /me/context
  2. GET /accounts/:accountId/entitlements
  3. GET /accounts/:accountId/usage
  4. POST /accounts/:accountId/subscription/checkout
  5. POST /accounts/:accountId/subscription/change-plan
  6. POST /accounts/:accountId/subscription/cancel
POST https://api.tinkerpayments.com/v1/accounts/{accountId}/subscription/checkout
Authorization: Bearer <token>
Content-Type: application/json

{
  "plan_id": "plan_123",
  "gateway": "auto",
  "billing_period": "monthly",
  "payment_method_id": "pm_xxx",
  "idempotency_key": "checkout-123"
}
POST https://api.tinkerpayments.com/v1/accounts/{accountId}/subscription/change-plan
Authorization: Bearer <token>
Content-Type: application/json

{
  "old_subscription_id": "sub_old",
  "plan_id": "plan_new",
  "gateway": "auto",
  "billing_period": "monthly",
  "start_at_period_end": true,
  "idempotency_key": "change-123"
}
POST https://api.tinkerpayments.com/v1/accounts/{accountId}/subscription/cancel
Authorization: Bearer <token>
Content-Type: application/json

{
  "subscription_id": "sub_123",
  "cancel_at_period_end": true
}