Como criar uma Assinatura usando a API?

Para criar uma nova assinatura usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/subscriptions.

Você pode acessar aqui a documentação referente a esse endpoint.

Como parte do body da requisição, esperamos o envio dos seguintes itens:

• value: O valor em centavos da assinatura a ser criada.
• customer: O cliente da assinatura a ser cobrado. Este campo é idempotente, o que significa que se você enviar dados de um cliente que já exista, utilizaremos o existente ao invés de criar um novo.

O body também aceita outros campos opcionais:

• dayGenerateCharge: Dia do mês em que as cobranças serão geradas. Deve ser um valor de 0 a 27.

Exemplo

O body da sua requisição será semelhante a este exemplo:

{
  "value": 100,
  "customer": {
    "name": "Dan",
    "taxID": "31324227036",
    "email": "email0@example.com",
    "phone": "5511999999999"
  }
}

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, retornaremos a assinatura criada.

Retornarmeros a seguinte resposta de exemplo:

{
  "subscription": {
    "globalID": "UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM=",
    "value": 100,
    "customer": {
      "name": "Dan",
      "email": "email0@example.com",
      "phone": "5511999999999",
      "taxID": {
        "taxID": "31324227036",
        "type": "BR:CPF"
      }
    },
    "dayGenerateCharge": 5
  }
}

Exemplos em código

Shell + cURL

 curl --request POST \
     --url https://api.openpix.com.br/api/v1/subscriptions \
     --header 'Authorization: AUTHORIZATION' \
     --header 'content-type: application/json' \
     --data '{"value": 100,"customer": {"name":"Dan","taxID":"31324227036","email":"email0@example.com","phone":"5511999999999"}}'

JavaScript + Fetch

fetch('https://api.openpix.com.br/api/v1/subscriptions', {
  method: 'POST',
  body: JSON.stringify({
    value: 100,
    customer: {
      name: 'Dan',
      taxID: '31324227036',
      email: 'email0@example.com',
      phone: '5511999999999',
    },
  }),
  headers: {
    Authorization: 'AUTHORIZATION',
    'Content-Type': 'application/json',
  },
}).then((res) => res.json());