v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Editar data de início da assinatura

Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar a data de início da assinatura.

patch/subscriptions/{subscription_id}/start-at

Path parameters

subscription_idstring required

Código da assinatura.<br>Formato: sub_XXXXXXXXXXXXXXXX.

Request body

start_atstring date required

Data de início da assinatura.

Response

200

idstring

codestring

start_atstring

intervalstring

interval_countinteger

billing_typestring

gateway_affiliation_idstring

boleto_due_daysinteger

minimum_priceinteger

next_billing_atstring

payment_methodstring

currencystring

statement_descriptorstring

installmentsinteger

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "sub_lmxK4k0hPfJ5z58w",
  "code": "9X8HROC4E0",
  "start_at": "2019-01-01T00:00:00Z",
  "interval": "month",
  "interval_count": 1,
  "billing_type": "prepaid",
  "gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538",
  "boleto_due_days": 5,
  "minimum_price": 10000,
  "next_billing_at": "2019-01-01T00:00:00Z",
  "payment_method": "credit_card",
  "currency": "BRL",
  "statement_descriptor": "Spotify",
  "installments": 1,
  "status": "active",
  "created_at": "2018-04-03T19:04:24Z",
  "updated_at": "2018-04-03T19:04:24Z",
  "customer": {
    "id": "cus_J4wRXJ0U6ytZrpOx",
    "name": "Tony Stark",
    "email": "tstark@avengers.com",
    "created_at": "2016-09-28T21:04:37Z",
    "updated_at": "2017-03-22T19:06:14Z"
  },
  "card": {
    "id": "card_pEYq7rDbFeiW8V6k",
    "last_four_digits": "8229",
    "brand": "Amex",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 2018,
    "status": "active",
    "created_at": "2016-11-16T17:02:39Z",
    "updated_at": "2016-12-29T12:03:24Z",
    "billing_address": {
      "line_1": "10880, Malibu Point, Malibu Central",
      "zip_code": "90265",
      "city": "Malibu",
      "state": "CA",
      "country": "US"
    }
  },
  "plan": {
    "id": "plan_pzrg5YhjyiqBgDw3",
    "name": "Plano Premium",
    "description": "Vá de Premium. E seja feliz!",
    "url": "/plans/plan_pzrg5YhjyiqBgDw3/mundipagg-teste/plano-premium",
    "statement_descriptor": "Spotify",
    "interval": "month",
    "interval_count": 1,
    "billing_type": "prepaid",
    "payment_methods": [
      "credit_card"
    ],
    "installments": [
      1
    ],
    "status": "active",
    "currency": "BRL",
    "created_at": "2017-04-03T19:04:05Z",
    "updated_at": "2017-04-03T19:04:05Z"
  },
  "items": [
    {
      "id": "si_K1Mj03JPSWFwxan4",
      "description": "Bola",
      "quantity": 1,
      "status": "active",
      "created_at": "2017-04-03T19:04:24Z",
      "updated_at": "2017-04-03T19:04:24Z",
      "pricing_scheme": {
        "price": 1490,
        "scheme_type": "unit"
      }
    }
  ]
}