Update a subscription purchase

Only the fields listed below are writable.

PUT/subscription_purchases/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idintegerrequired

Request body

requiredapplication/json

statestring

next_payment_onstring<date>

total_renewal_feeinteger

remaining_paymentsinteger

subscription_fee_idinteger

cancel_atstring<date>

payments_to_skipinteger

paused_bystring

last_pause_atstring<date-time>

renewal_discountnumber

discount_num_chargesinteger

end_datestring<date>

Responses

200

Subscription purchase updated

_linksHalLinks

idinteger

shop_idinteger

contact_idinteger

original_order_idinteger

product_idinteger

product_namestring

statestring

currency_codestring

total_renewal_feeinteger

In cents

payment_intervalstring

total_paymentsinteger

remaining_paymentsinteger

failed_attemptsinteger

last_payment_onstring<date>

next_payment_onstring<date>

start_datestring<date>

end_datestring<date> | null

cancel_atstring<date> | null

subscription_fee_idinteger

renewal_discountnumber

discount_num_chargesinteger

payments_to_skipinteger

paused_bystring

paid_setup_feeboolean

unitsinteger

created_onstring<date-time>

updated_onstring<date-time>

422

Validation error (e.g. invalid state, or no updatable fields provided)

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

statestringnext_payment_onstringtotal_renewal_feeintegerremaining_paymentsintegersubscription_fee_idintegercancel_atstringpayments_to_skipintegerpaused_bystringlast_pause_atstringrenewal_discountnumberdiscount_num_chargesintegerend_datestring

Request

curl -X PUT 'https://api.onbolder.com/v2/subscription_purchases/0' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "state": "paused",
  "paused_by": "admin"
}'

const response = await fetch("https://api.onbolder.com/v2/subscription_purchases/0", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"state\": \"paused\",\n  \"paused_by\": \"admin\"\n}"
});

import requests

response = requests.put(
    "https://api.onbolder.com/v2/subscription_purchases/0",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"state\": \"paused\",\n  \"paused_by\": \"admin\"\n}",
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "shop_id": 0,
  "contact_id": 0,
  "original_order_id": 0,
  "product_id": 0,
  "product_name": "string",
  "state": "string",
  "currency_code": "string",
  "total_renewal_fee": 0,
  "payment_interval": "string",
  "total_payments": 0,
  "remaining_payments": 0,
  "failed_attempts": 0,
  "last_payment_on": "2019-08-24",
  "next_payment_on": "2019-08-24",
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "cancel_at": "2019-08-24",
  "subscription_fee_id": 0,
  "renewal_discount": 0,
  "discount_num_charges": 0,
  "payments_to_skip": 0,
  "paused_by": "string",
  "paid_setup_fee": true,
  "units": 0,
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}