Skip to main content
POST
Criação de uma nova assinatura

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Body

application/json
name
string
required

Nome da assinatura

Example:

"Assinatura Premium com Eventos"

merchantId
string<uuid>
required

Identificador do merchant

Example:

"225d39bc-1fbb-480a-90bd-f0caad05d2d0"

customerId
string<uuid>
required

Identificador do cliente

Example:

"2a8b64ce-904c-4256-b79a-49525808609c"

items
object[]
required
recurrence
object
required
paymentMethod
object
required
referenceKey
string

Chave de referência da assinatura no seu sistema

Example:

"SUB-PREMIUM-001"

trial
object

Configuração do período de trial (opcional)

splitRules
object[]

Regras de divisão de valores entre recebedores (opcional)

Response

201 - application/json

Created

id
string<uuid>

Identificador da assinatura

Example:

"019860b2-feb8-7edf-b5ba-0c48a7a8bd3f"

name
string

Nome da assinatura

Example:

"Assinatura Premium com Eventos"

clientId
string<uuid>

Identificador do client

Example:

"e234eeb3-483d-4df2-87eb-1e2be5cdaccd"

merchantId
string<uuid>

Identificador do merchant

Example:

"225d39bc-1fbb-480a-90bd-f0caad05d2d0"

customerId
string<uuid>

Identificador do cliente

Example:

"2a8b64ce-904c-4256-b79a-49525808609c"

referenceKey
string

Chave de referência da assinatura

Example:

"SUB-PREMIUM-001"

currency
string

Moeda da assinatura

Example:

"BRL"

items
object[]
recurrence
object
paymentMethod
object
trial
object

Informações do período de trial (se aplicável)

splitRules
object[]

Regras de divisão de valores entre recebedores

status
enum<string>

Status da assinatura

Available options:
created,
active,
paused,
canceled,
unpaid,
expired,
trialing
Example:

"created"

amount
integer
Example:

29900

liveMode
boolean

Indica se a assinatura está em modo de produção

Example:

true

lastCycle
object | null

Último cycle da assinatura. Sempre presente nas respostas individuais (GET, CREATE, UPDATE), pode ser null se não houver cycles.

createdAt
string<date-time>
Example:

"2025-07-31T13:36:40.118822Z"

updatedAt
string<date-time>
Example:

"2025-07-31T13:36:40.118822Z"

cancelAtPeriodEnd
boolean

Indica se a assinatura está agendada para cancelamento ao final do período atual

Example:

true

scheduledCancellationAt
string<date> | null

Data agendada para o cancelamento (formato YYYY-MM-DD). Quando definida, tem prioridade sobre trialEnd e nextDueDate para determinar a data efetiva de cancelamento

Example:

"2025-12-31"

scheduledCancellationReason
string | null

Motivo do cancelamento agendado (opcional)

Example:

"Cliente solicitou cancelamento"