Skip to main content
POST
Create Subscription

Authorizations

Authorization
string
header
required

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

Body

application/json
productId
string
required

ID (ObjectId) de um produto ativo que define o valor e o nome da assinatura.

customer
object
required

Dados do titular da conta que vai pagar. Nome e documento são obrigatórios fora do sandbox.

callbackUrl
string<uri>

URL HTTPS pública para os webhooks da assinatura (subscription.*) e de cada pagamento (payment.paid). Máximo de 500 caracteres.

Maximum string length: 500
metadata
string
default:{}

String JSON com dados livres, devolvida em todos os eventos da assinatura. Máximo de 2048 caracteres.

Maximum string length: 2048
frequency
enum<string>
default:MONTHLY

Periodicidade da renovação.

Available options:
WEEKLY,
MONTHLY,
QUARTERLY,
SEMIANNUALLY,
ANNUALLY
dayGenerateCharge
integer

Dia do mês do débito automático (1 a 28). Sem ele, o dia da compra. Não vale para a periodicidade semanal.

Required range: 1 <= x <= 28

Response

Assinatura criada. O primeiro pagamento e a autorização acontecem quando o cliente paga o QR.

paymentId
string

Identificador do primeiro pagamento da assinatura (prefixo psa_sub_). As renovações têm o sufixo _c1, _c2…

status
string

Status do primeiro pagamento. Sempre "pending" na criação.

type
string

Tipo do pagamento. Sempre "subscription".

subscriptionId
string

Identificador da recorrência (29 caracteres, começa com R). É a chave estável entre todos os ciclos.

authorizationStatus
enum<string>

Estado da autorização no banco do cliente. Na criação é sempre pending_authorization (sandbox no ambiente de teste).

Available options:
pending_authorization,
active,
rejected,
expired,
cancelled,
ended,
sandbox
amountCents
integer

Valor de cada ciclo em centavos, definido pelo produto.

currency
string

Moeda do produto (ex. "BRL").

productName
string

Nome do produto vinculado à assinatura.

frequency
enum<string>

Periodicidade aplicada.

Available options:
WEEKLY,
MONTHLY,
QUARTERLY,
SEMIANNUALLY,
ANNUALLY
environment
enum<string>

Ambiente em que a assinatura foi criada.

Available options:
live,
sandbox
pix
object

O QR composto do Pix Automático.

nextChargeDate
string<date> | null

Data (YYYY-MM-DD) do primeiro débito automático, um período depois da compra.

dayGenerateCharge
integer | null

Dia do mês informado na criação, ou null.