---
title: "Criar assinatura"
method: POST
path: "/Recurrence/V1/Plans/{Id}/Subscriptions"
---

# Criar assinatura

`POST /Recurrence/V1/Plans/{Id}/Subscriptions`

## Request

- Base URL: `https://services.safe2pay.com.br`
- URL: `https://services.safe2pay.com.br/Recurrence/V1/Plans/{Id}/Subscriptions`
- Auth: API key in header `X-API-KEY`

Serviço responsável por criar uma assinatura vinculada a um plano.

## Path parameters

- `Id` integer, required

## Headers

- `X-API-KEY` string, required

## Request body

- object
  - `PaymentMethod` string, required: Código do método de pagamento.
  - `Customer` object, required: Grupo de dados com informação do cliente.
    - `Name` string, required: Nome do cliente.
    - `Identity` string, required: Documento de identificação (CPF / CNPJ) do cliente.
    - `Phone` string, required: Telefone do cliente.
    - `Email` string, required: Email do cliente.
    - `Address` object: Grupo de dados com a informação do endereço do cliente.
      - `Street` string, required: Rua do cliente.
      - `Number` string, required: Número da rua do cliente.
      - `District` string, required: Bairro do cliente
      - `ZipCode` string, required: CEP do cliente.
      - `Complement` string: Apartamento XYZ
      - `City` object: Grupo de dados com a informação da Cidade.
        - `CodeIBGE` string, required: Código IBGE da cidade do cliente.
  - `Emails` string[], required: Esses e-mails receberão o link para tokenização do cartão no momento da assinatura ou o boleto de cobrança.
  - `Token` string: Token de identificação do cartão de crédito.
  - `ExternalAuthentication` object: Objeto de validação do 3DS
    - `Cavv` string
    - `Xid` string
    - `Eci` string, required
    - `ReferenceID` string, required
    - `Version` string

## Response `200`

200

- union
  - object
    - `success` boolean
    - `data` object
      - `idSubscription` integer
      - `subscriptionStatusCode` string
  - object
    - `success` boolean
    - `data` object
      - `idSubscription` integer
      - `subscriptionStatusCode` string
      - `chargeUrl` string
  - object
    - `success` boolean
    - `data` object
      - `idSubscription` integer
      - `subscriptionStatusCode` string

## Other responses

- `422`: 422

---

[API](https://skmtc.dev/safe2pay/apis/services.md) - [All operations](https://skmtc.dev/safe2pay/apis/services/llms.txt) - [OpenAPI document](https://skmtc.dev/safe2pay/apis/services/revisions/133a27b98247?raw)