Skip to main content
POST
/
subscriptions
Criar Assinaturas em Massa
curl --request POST \
  --url https://api.example.com/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "start_date": "<string>",
  "expiry_date": "<string>",
  "plan_id": "<string>",
  "is_group_plan": true,
  "group_size": "<string>",
  "benefit_holder": "<string>",
  "beneficiary": {
    "beneficiary.primary_card": "<string>",
    "beneficiary.user_card": "<string>",
    "beneficiary.name": "<string>",
    "beneficiary.cpf": "<string>",
    "beneficiary.birth_date": "<string>",
    "beneficiary.gender": "<string>",
    "beneficiary.email": "<string>",
    "beneficiary.phone_number": "<string>",
    "beneficiary.address": {
      "beneficiary.address.zipcode": "<string>",
      "beneficiary.address.street": "<string>",
      "beneficiary.address.number": "<string>",
      "beneficiary.address.complement": "<string>",
      "beneficiary.address.neighborhood": "<string>",
      "beneficiary.address.city": "<string>",
      "beneficiary.address.state": "<string>"
    }
  },
  "partner_metadata": "<string>",
  "partner_internal_id": "<string>"
}
'
{
  "result": "success",
  "total_created_items": 1,
  "total_not_created_items": 0,
  "not_created_items": []
}

​
Visão Geral

Este endpoint permite que parceiros criem assinaturas em massa para múltiplos beneficiários em uma única requisição. É ideal para onboarding de grupos de usuários ou empresas.

​
Autenticação

​
x-api-key
string
required
Sua chave de API fornecida pela Zentek. Exemplo: ztk_live_...

​
Request Body

O corpo da requisição deve ser um array de objetos, onde cada objeto representa uma assinatura.
​
start_date
string
required
Data de início da assinatura no formato ISO 8601. Exemplo: 2024-01-01
​
expiry_date
string
required
Data de expiração da assinatura no formato ISO 8601. Deixe vazio para assinatura sem data de término.
​
plan_id
string
required
Identificador único do plano. Exemplo: plan_10000
​
is_group_plan
boolean
required
Define se é uma assinatura em grupo (true/false).
​
group_size
string
Tamanho do grupo. Mínimo: 50. Obrigatório se is_group_plan for true.
​
benefit_holder
string
CNPJ do titular do benefício (empresa). Obrigatório se is_group_plan for true.
​
beneficiary
object
required
Objeto contendo os dados do beneficiário.
​
partner_metadata
string
String JSON contendo metadados adicionais do parceiro (opcional).
​
partner_internal_id
string
ID interno do parceiro para referência (opcional).

​
Exemplo de Request

curl -X POST "https://api.partner.zentek.com.br/v1/subscriptions" \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_API_KEY" \
  -d '[
    {
      "start_date": "2024-01-01",
      "expiry_date": "2025-01-01",
      "plan_id": "plan_10000",
      "is_group_plan": false,
      "group_size": "",
      "benefit_holder": "",
      "beneficiary": {
        "primary_card": "27030474015",
        "user_card": "27030474015",
        "name": "João Silva",
        "cpf": "34567898233",
        "birth_date": "1990-02-22",
        "gender": "M",
        "email": "joao.silva@example.com",
        "address": {
          "zipcode": "06454040",
          "street": "Rua Exemplo",
          "number": "123",
          "complement": "Apto 45",
          "neighborhood": "Centro",
          "city": "São Paulo",
          "state": "SP"
        },
        "phone_number": "+5511996042491"
      },
      "partner_metadata": "{\"customer_id\": \"12345\"}"
    }
  ]'

​
Response

​
result
string
Resultado geral da operação.
​
total_created_items
number
Número total de assinaturas criadas com sucesso.
​
total_not_created_items
number
Número total de assinaturas que falharam.
​
not_created_items
array
Lista de itens que não foram criados, com detalhes dos erros.
{
  "result": "success",
  "total_created_items": 1,
  "total_not_created_items": 0,
  "not_created_items": []
}