Sign in

v1

latestOpenAPI 3.0.02026-08-0610682246.0 KB
Payments

Start the subscription

Uses the payment info captured by the payment provider drop-in UI and create a customer with a recurring payment. When the payment provider responds successfully, the logged-in user will be temporarily granted all entitlements in the product's associated bundle.

post/zephr/subscribe

Headers

cookiestring

The session cookie.

Request body

product_idstring required

Product ID/slug

plan_idstring

Plan ID/slug

discount_codestring

Discount/promotion code

Example request

{
  "product_id": "premium-access-monthly-recurring",
  "plan_id": "plan-5",
  "discount_code": "SAVE10",
  "vendor_fields": {
    "payment_nonce": "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ==",
    "skip_trial_period": true,
    "start_date": "2021-01-01T00:00:00Z",
    "payment_method": "pm_123456789",
    "vault_payment_method": false
  }
}

Response

OK

grant_idstring

New grant of product bundle to user.

client_secretstring

(Stripe) reference to Stripe payment required to process payment in front end.

payment_intent_idstring

(Stripe) reference to the payment intent if payment requires confirmation.

Example response

{
  "grant_id": "33d576c7-d036-40e7-8141-8a91998a5c79",
  "client_secret": "src_client_secret_QfsM25CJ2uCMon72MiOmUNTj`",
  "payment_intent_id": "pi_1GYZYWLgUJT2XNPAYQMomeqf"
}