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 cliente. O nome é obrigatório para assinaturas.

callbackUrl
string<uri>

URL HTTPS pública para receber os webhooks das cobranças. Máximo de 500 caracteres.

Maximum string length: 500
metadata
string
default:{}

String JSON com dados livres. Máximo de 2048 caracteres.

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

Frequência de cobrança da assinatura.

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

Dia do mês em que as cobranças são geradas (entre 4 e 28).

Required range: 4 <= x <= 28

Response

Assinatura criada com sucesso.

paymentId
string

Identificador do pagamento da assinatura (prefixo psa_sub_).

status
string

Status da assinatura. Sempre "pending" na criação.

type
string

Tipo do pagamento. Sempre "subscription".

subscriptionId
string

Identificador da assinatura no gateway de pagamento.

amountCents
integer

Valor de cada cobrança em centavos, definido pelo produto.

currency
string

Moeda do produto (ex. "BRL").

productName
string

Nome do produto vinculado à assinatura.

frequency
enum<string>

Frequência de cobrança aplicada.

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

Ambiente em que a assinatura foi criada.

Available options:
live,
sandbox
pix
object

Dados PIX da primeira cobrança.

dayGenerateCharge
integer

Dia do mês em que as cobranças são geradas. Se não informado, usa o dia atual.