v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Editar metadados da assinatura

Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível atualizar o objeto metadata da assinatura.

patch/subscriptions/subscription_id/metadata

Path parameters

subscription_idstring required

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

Request body

metadatastring required

Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.<br>Saiba mais sobre metadata

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_yOkq7oI03S7Wq741",
  "code": "V9OMHENIK6",
  "start_at": "2017-08-10T00:00:00Z",
  "interval": "month",
  "interval_count": 1,
  "billing_type": "postpaid",
  "gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538",
  "boleto_due_days": 5,
  "minimum_price": 10000,
  "current_cycle": {
    "id": "cycle_Z82JyBgSM2iwe4Lp",
    "start_at": "2017-08-10T00:00:00Z",
    "end_at": "2017-09-09T23:59:59Z",
    "billing_at": "2017-09-10T00:00:00Z"
  },
  "setup": {
    "id": "or_8e0l1KGFZgIpzNVG",
    "description": "Inscrição",
    "amount": 9990,
    "status": "paid"
  },
  "next_billing_at": "2017-09-10T00:00:00Z",
  "payment_method": "credit_card",
  "currency": "BRL",
  "statement_descriptor": "Spotify",
  "installments": 1,
  "status": "active",
  "created_at": "2017-08-10T21:27:13Z",
  "updated_at": "2017-08-10T21:27:29Z",
  "customer": {
    "id": "cus_4jEgBpgfbIe6vnqy",
    "name": "Tony Stark",
    "email": "f95783c1-c288-4dfb-9e1f-c3b9a4d55a7b@avengers.com",
    "created_at": "2017-08-10T21:27:11Z",
    "updated_at": "2017-08-10T21:27:11Z"
  },
  "card": {
    "id": "card_bQzW0GMfnAsry6KM",
    "first_six_digits": "342793",
    "last_four_digits": "8229",
    "brand": "Amex",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 2018,
    "status": "active",
    "created_at": "2017-08-10T21:27:12Z",
    "updated_at": "2017-08-10T21:27:12Z",
    "billing_address": {
      "line_1": "10880, Malibu Point, Malibu Central",
      "zip_code": "90265",
      "city": "Malibu",
      "state": "CA",
      "country": "US"
    },
    "type": "credit"
  },
  "plan": {
    "id": "plan_jEJWD1qF2Xf92eKv",
    "name": "Premium",
    "description": "Vá de Premium. E seja feliz!",
    "url": "/plans/plan_jEJWD1qF2Xf92eKv/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": "2017-08-10T21:27:08Z",
    "updated_at": "2017-08-10T21:27:08Z"
  },
  "items": [
    {
      "id": "si_ZY8Vrapsnu9QjMde",
      "description": "Premium",
      "quantity": 1,
      "status": "active",
      "created_at": "2017-08-10T21:27:14Z",
      "updated_at": "2017-08-10T21:27:14Z",
      "pricing_scheme": {
        "price": 1490,
        "scheme_type": "unit"
      }
    }
  ],
  "metadata": {
    "code": "1234",
    "company": "Avengers"
  }
}