Skip to main content
POST
Simular ciclo de assinatura

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string
required
Required string length: 1 - 255

Path Parameters

id
string<uuid>
required

Body

application/json
action
enum<string>
required
Available options:
FAIL_INVOICE,
PAY_INVOICE
expectedVersion
integer
required
Required range: x >= 1
invoiceId
string<uuid>
required

Response

Default Response

accessUntil
string<date-time> | null
required
currentPeriodEnd
string<date-time> | null
required
currentPeriodStart
string<date-time> | null
required
priceId
string<uuid>
required
status
enum<string>
required
Available options:
ACTIVE,
CANCELED,
EXPIRED,
PAST_DUE,
PENDING_AUTHORIZATION
version
integer
required
Required range: x >= 1