Skip to main content
Create a provider-hosted billing portal redirect

Authorizations

Authorization
string
header
required

Opaque control credential

Headers

Idempotency-Key
string
required
Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json

The body is of type object.

Response

Existing billing portal redirect

schemaVersion
enum<number>
required
Available options:
1
billingRedirectId
string
required
Pattern: ^billredirect_[0-9a-z]{12,32}$
kind
enum<string>
required
Available options:
checkout,
portal
url
string<uri>
required
Pattern: ^https:\/\/.*
expiresAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991