Criar página de pagamento recorrente

Exemplo completo para criar uma página de pagamento com recorrência no Checkout Cielo

Para criar uma cobrança recorrente, inclua o nó Payment.RecurrentPayment na requisição. A recorrência é criada somente se a primeira transação for autorizada.

⚠️
Atenção: Pedidos com recorrência devem ter Shipping.Type = "WithoutShipping", independentemente do tipo de produto.

Requisição

POST https://cieloecommerce.cielo.com.br/api/public/v1/orders/

header 'Authorization: Bearer {access_token}'

{
  "OrderNumber": "REC20260701",
  "SoftDescriptor": "Assinatura Mensal",
  "Cart": {
    "Items": [
      {
        "Name": "Plano Mensal Premium",
        "Description": "Assinatura mensal do Plano Premium",
        "UnitPrice": 9900,
        "Quantity": 1,
        "Type": "Service",
        "Sku": "PLAN-PREMIUM-001"
      }
    ]
  },
  "Shipping": {
    "Type": "WithoutShipping"
  },
  "Payment": {
    "RecurrentPayment": {
      "Interval": "Monthly",
      "EndDate": "2029-07-01"
    }
  },
  "Customer": {
    "Identity": "12345678909",
    "FullName": "Aline Souza",
    "Email": "[email protected]",
    "Phone": "11999999999"
  }
}

Parâmetros de `Payment.RecurrentPayment`

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório
`Payment.RecurrentPayment.Interval`	Intervalo entre as cobranças recorrentes. Valores: `"Monthly"`, `"Bimonthly"`, `"Quarterly"`, `"SemiAnnual"`, `"Annual"`.	alfanumérico	10	Não
`Payment.RecurrentPayment.EndDate`	Data de encerramento da recorrência (formato `YYYY-MM-DD`). Se não informado, a recorrência é encerrada somente se cancelada.	date	10	Não

Resposta

{
  "settings": {
    "checkoutUrl": "https://cieloecommerce.cielo.com.br/transacional/order/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "Profile": "CheckoutCielo",
    "Version": 1
  }
}

Propriedade	Descrição	Tipo	Formato
`settings.checkoutUrl`	URL da página de pagamento a ser exibida ao comprador. A transação é criada somente quando o comprador finaliza o pagamento nessa página.	string	URL
`settings.Profile`	Perfil da loja no Checkout Cielo.	string	—
`settings.Version`	Versão do processo de criação do pedido.	número	—