v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Criar assinatura de plano

Fornecemos a possibilidade de criação de uma assinatura (subscription) a partir de plano (plan).

post/subscriptions

Request body

codestring

Código da assinatura no sistema da loja.

plan_idstring required

Código do plano. Formato: plan_XXXXXXXXXXXXXXXX

payment_methodstring required

Meio de pagamento. Valores possíveis: credit_card, boleto e debit_card .

start_atstring date

Data de início da assinatura . Se não for informada, a assinatura será iniciada imediatamente.

customer_idstring required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX Obrigatório, caso o customer não seja informado.

customerobject required

Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes.

cardobject required

Dados sobre o pagamento com cartão de crédito. Obrigatório, caso o payment_method seja credit_card. Saiba mais sobre pagamentos com cartão de crédito.

gateway_affiliation_idstring

Código de afiliação no gateway.

boleto_due_daysinteger

Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)

metadataobject

Objeto chave/valor utilizado para armazenar informações adicionais sobre o assinatura. Saiba mais sobre metadata.

Response

200

idstring

codestring

start_atstring

intervalstring

interval_countinteger

billing_typestring

next_billing_atstring

payment_methodstring

currencystring

statement_descriptorstring

installmentsinteger

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "sub_bpYjMr9f8sA6QJNg",
  "code": "XPLMBV9U10",
  "start_at": "2018-04-04T00:00:00Z",
  "interval": "month",
  "interval_count": 1,
  "billing_type": "postpaid",
  "current_cycle": {
    "id": "cycle_j6WnJ7ei1hW68bXo",
    "start_at": "2018-04-04T00:00:00Z",
    "end_at": "2018-05-03T23:59:59Z",
    "billing_at": "2018-05-04T00:00:00Z"
  },
  "next_billing_at": "2018-05-04T00:00:00Z",
  "payment_method": "boleto",
  "currency": "BRL",
  "statement_descriptor": "Spotify",
  "installments": 1,
  "status": "active",
  "created_at": "2018-04-04T21:36:13Z",
  "updated_at": "2018-04-04T21:36:13Z",
  "customer": {
    "id": "cus_qr2AgDGiOhr61Y5L",
    "name": "Tony Stark",
    "email": "cc25e912-197c-4626-a85d-8c0597e9b157@avengers.com",
    "created_at": "2018-04-04T21:36:13Z",
    "updated_at": "2018-04-04T21:36:13Z"
  },
  "plan": {
    "id": "plan_85AK5eF15feLKM4J",
    "name": "Premium",
    "description": "Vá de Premium. E seja feliz!",
    "url": "/plans/plan_85AK5eF15feLKM4J/mundipagg-teste/premium",
    "statement_descriptor": "Spotify",
    "interval": "month",
    "interval_count": 1,
    "billing_type": "postpaid",
    "payment_methods": [
      "boleto"
    ],
    "installments": [
      1
    ],
    "status": "active",
    "currency": "BRL",
    "created_at": "2018-04-04T21:36:09Z",
    "updated_at": "2018-04-04T21:36:09Z"
  },
  "items": [
    {
      "id": "si_xGw3AeYiaTJ639A6",
      "name": "Name - Premium",
      "description": "Test - Description",
      "quantity": 1,
      "status": "active",
      "created_at": "2018-04-04T21:36:13Z",
      "updated_at": "2018-04-04T21:36:13Z",
      "pricing_scheme": {
        "price": 1490,
        "scheme_type": "unit"
      }
    }
  ]
}