Skip to main content
GET
Obter assinatura

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

Default Response

accessUntil
string<date-time> | null
required
amountMinor
integer
required
Required range: 1 <= x <= 9007199254740991
billingInterval
enum<string>
required
Available options:
MONTH,
YEAR
cancelAtPeriodEnd
boolean
required
cancellation
object | null
required
createdAt
string<date-time>
required
currency
enum<string>
required
Available options:
BRL
currentPeriodEnd
string<date-time> | null
required
currentPeriodStart
string<date-time> | null
required
customerId
string<uuid>
required
gracePeriodDays
integer
required
Required range: x >= 0
id
string<uuid>
required
intervalCount
integer
required
Required range: x >= 1
nextBillingAt
string<date-time> | null
required
offerId
string<uuid>
required
offerName
string
required
Required string length: 1 - 120
orderId
string<uuid>
required
paymentMethod
enum<string>
required
Available options:
PIX,
CARD
priceId
string<uuid>
required
productId
string<uuid>
required
productImageUrl
string | null
required
Maximum string length: 2048
productName
string
required
Required string length: 1 - 120
renewalStoppedAt
string<date-time> | null
required
status
enum<string>
required
Available options:
ACTIVE,
CANCELED,
EXPIRED,
PAST_DUE,
PENDING_AUTHORIZATION
updatedAt
string<date-time>
required
version
integer
required
Required range: x >= 1