Skip to main content
GET
Get Subscription

Authorizations

Authorization
string
header
required

Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

Path Parameters

id
string
required

paymentId (psa_sub_…) ou subscriptionId.

Response

A assinatura.

paymentId
string
subscriptionId
string
status
string

Status do primeiro pagamento.

authorizationStatus
string

pending_authorization, active, rejected, expired, cancelled, ended ou sandbox.

type
string
environment
string
amountCents
integer
currency
string
productName
string
frequency
string
nextChargeDate
string<date> | null
firstChargeDate
string<date> | null

Data do primeiro débito automático.

cyclesPaid
integer
customer
object
metadata
string
pix
object
paidAt
string<date-time> | null
authorizedAt
string<date-time> | null
cancelledAt
string<date-time> | null
cancellationReason
string

Código e descrição do encerramento, quando há.

lastError
string

Último problema ao enviar uma cobrança recorrente, quando há.

createdAt
string<date-time>
charges
object[]

As cobranças recorrentes já enviadas ao banco, em ordem de ciclo.