---
title: "Criar assinatura"
method: POST
path: "/v2/subscriptions"
tags: ["Assinaturas"]
---

# Criar assinatura

`POST /v2/subscriptions`

## Request

- Base URL: `https://api.barte.com`
- URL: `https://api.barte.com/v2/subscriptions`
- Auth: API key in header `X-Token-Api`
- TypeScript: <https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada/docs/v2/subscriptions/post.ts> (a function with typed inputs; its response is checked against the schema)

Cria uma nova assinatura

## Headers

- `X-Token-Api` string, required
- `Content-Type` 'application/json'
- `x-ip-origin-request` string
- `x-idempotency-key` string

## Request body

- SubscriptionRequest
  - `uuidPlan` string, uuid, required
  - `basicValue` BasicValueRequest, required
    - `type` 'MONTHLY' | 'SEMESTER' | 'YEARLY', required
    - `valuePerMonth` number, double, required
  - `additionalValue` AdditionalValueRequest
    - `installments` integer
    - `value` number, double
  - `payment` PaymentRequest, required
    - `method` 'CREDIT_CARD_EARLY_SELLER', required: Método de pagamento
    - `card` CardRequest, required
      - `cardToken` string, uuid, required: Token do cartão
      - `cvv` string, required: Código de segurança do cartão
    - `fraudData` FraudDataRequest, required
      - `internationalDocument` DocumentRequest
        - `documentNumber` string, required: Número do documento
        - `documentType` 'cpf' | 'cnpj', required: Tipo do documento
        - `documentNation` string, required: País do documento
      - `name` string: Nome do portador do cartão
      - `email` string, email: Email do portador do cartão
      - `phone` string: Telefone do portador do cartão
      - `billingAddress` BillingAddressRequest
        - `country` string, required: País
        - `state` string, required: Estado
        - `city` string, required: Cidade
        - `district` string, required: Bairro
        - `street` string, required: Rua
        - `zipCode` string, required: CEP
        - `number` string, required: Número
        - `complement` string: Complemento
    - `storedCredential` StoredCredentialRequest
      - `initiator` 'CARDHOLDER' | 'MERCHANT', required: Quem iniciou a transação: CARDHOLDER (cliente autorizou) ou MERCHANT (seller iniciou automaticamente)
      - `reason` 'INITIAL' | 'RECURRING' | 'INSTALLMENT' | 'UNSCHEDULED', required: Tipo de recorrência: INITIAL (primeira transação), RECURRING (cobrança fixa), INSTALLMENT (parcelamento), UNSCHEDULED (cobrança avulsa)
  - `uuidBuyer` string, uuid, required
  - `startDate` string, date, required
  - `metadata` MetadataRequest[]
    - `key` string, required
    - `value` union, required
      - string
      - number

## Response `201`

Assinatura criada com sucesso

- SubscriptionResponse
  - `uuid` string
  - `status` 'PENDING' | 'ACTIVE' | 'DEFAULTER' | 'INACTIVE'
  - `customer` CustomerResponse
    - `document` string: Documento do cliente
    - `type` string: Tipo do documento
    - `documentCountry` string: País do documento
    - `name` string: Nome do cliente
    - `email` string, email: Email do cliente
    - `phone` string: Telefone do cliente
    - `alternativeEmail` string, email: Email alternativo
    - `integrationCustomerId` string, uuid: ID de integração do cliente
  - `startDate` string, date
  - `value` BasicValueResponse
    - `type` 'MONTHLY' | 'SEMESTER' | 'YEARLY'
    - `valuePerMonth` number, double
  - `additionalValue` AdditionalValueResponse
    - `installments` integer
    - `value` number, double
  - `paymentMethod` 'CREDIT_CARD' | 'PIX' | 'BANK_SLIP'
  - `charges` ChargeResponse[]
    - `uuid` string, uuid: UUID da cobrança
    - `title` string: Título da cobrança
    - `expirationDate` string, date: Data de expiração
    - `value` number: Valor da cobrança
    - `paymentMethod` string: Método de pagamento
    - `status` 'SCHEDULED' | 'APPROVED' | 'DECLINED' | 'PENDING': Status da cobrança
    - `customer` object
      - `document` string
      - `type` string
      - `name` string
      - `email` string, email
      - `phone` string
      - `alternativeEmail` string, email

## Other responses

- `400`: Erro de validação ou negócio
- `401`: Token inativo ou inexistente
- `403`: Acesso negado
- `415`: Tipo de mídia não suportado
- `500`: Erro interno do servidor

---

[API](https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada.md) - [All operations](https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada/llms.txt) - [OpenAPI document](https://skmtc.dev/barte/apis/api-de-sellers-v2-atualizada/revisions/f0dd55b167f1?raw)