Subscriptions

Use these endpoints to create and query subscriptions.

Create Pix subscription

Create a recurring subscription charged through Pix.

Create card subscription

Create a recurring subscription charged through card.

Create crypto subscription

Create a recurring subscription charged through crypto.

Search subscriptions

Query subscriptions created through the API.

Common creation payload

{
  "identifier": "assinatura-123",
  "amount": 97,
  "client": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "phone": "(11) 99999-9999",
    "document": "123.456.789-00"
  },
  "product": {
    "id": "plano-mensal",
    "name": "Plano mensal",
    "price": 97
  },
  "subscription": {
    "periodicityType": "MONTHS",
    "periodicity": 1,
    "firstChargeIn": 0
  },
  "callbackUrl": "https://example.com/webhooks/payment"
}

Periodicity

DAYS
WEEKS
MONTHS
YEARS

⌘I

Getting started

Endpoints

Webhooks

FAQ

Create Pix subscription

Create card subscription

Create crypto subscription

Search subscriptions

Common creation payload

Periodicity

Create Pix subscription

Create card subscription

Create crypto subscription

Search subscriptions

​Common creation payload

​Periodicity

Common creation payload

Periodicity