Subscriptions

Update or swap a subscription

Updates or swaps an existing subscription:

cancel: Schedules cancellation at the end of the current billing period (cancel_at_period_end: true, status remains active/trialing). Dispatches subscription.canceled and subscription.updated.
cancel_immediately: Cancels the subscription immediately (status: "canceled", cancel_at_period_end: false, and current_period_end is immediately updated to the termination timestamp). Dispatches subscription.canceled.
resume: Reverses a scheduled period-end cancellation (cancel_at_period_end: false). Dispatches subscription.uncanceled and subscription.updated.
swap: Immediately upgrades or downgrades the subscription to a new variant_id or product_id with automatic proration (create_prorations). Works in both Live and Test mode. Dispatches subscription.upgraded and subscription.updated.

PATCH

subscriptions

{id}

Update or swap a subscription

curl --request PATCH \
  --url https://api.blink.store/v1/subscriptions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-store-id: <x-store-id>' \
  --data '
{
  "variant_id": "<string>",
  "product_id": "<string>"
}
'

import requests

url = "https://api.blink.store/v1/subscriptions/{id}"

payload = {
    "variant_id": "<string>",
    "product_id": "<string>"
}
headers = {
    "x-store-id": "<x-store-id>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-store-id': '<x-store-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variant_id: '<string>', product_id: '<string>'})
};

fetch('https://api.blink.store/v1/subscriptions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blink.store/v1/subscriptions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'variant_id' => '<string>',
    'product_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-store-id: <x-store-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blink.store/v1/subscriptions/{id}"

	payload := strings.NewReader("{\n  \"variant_id\": \"<string>\",\n  \"product_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-store-id", "<x-store-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.blink.store/v1/subscriptions/{id}")
  .header("x-store-id", "<x-store-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variant_id\": \"<string>\",\n  \"product_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blink.store/v1/subscriptions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-store-id"] = '<x-store-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variant_id\": \"<string>\",\n  \"product_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "store_id": "<string>",
    "product_id": "<string>",
    "variant_id": "<string>",
    "status": "<string>",
    "current_period_end": "2023-11-07T05:31:56Z",
    "cancel_at_period_end": true,
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "stripe_subscription_id": "<string>",
    "stripe_customer_id": "<string>",
    "product": {
      "id": "<string>",
      "name": "<string>",
      "pricing_model": "standard",
      "subscription_interval": "day",
      "subscription_interval_count": 2
    },
    "variant": {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "subscription_interval": "day",
      "subscription_interval_count": 2
    },
    "customer_id": "<string>",
    "custom_data": {},
    "is_test": true
  }
}

Headers

x-store-id

string

required

Path Parameters

string

required

Body

application/json

action

enum<string>

required

cancel (at period end), cancel_immediately (terminate now and set current_period_end to now), resume (undo pending cancel), or swap (change plan/variant with proration).

Available options:

cancel,

cancel_immediately,

resume,

swap

variant_id

string

Target variant UUID when action is swap.

product_id

string

Target product UUID when action is swap (optional if variant_id is provided).

Response

Subscription updated successfully

data

object

Show child attributes

Update or swap a subscription

curl --request PATCH \
  --url https://api.blink.store/v1/subscriptions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-store-id: <x-store-id>' \
  --data '
{
  "variant_id": "<string>",
  "product_id": "<string>"
}
'

import requests

url = "https://api.blink.store/v1/subscriptions/{id}"

payload = {
    "variant_id": "<string>",
    "product_id": "<string>"
}
headers = {
    "x-store-id": "<x-store-id>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-store-id': '<x-store-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variant_id: '<string>', product_id: '<string>'})
};

fetch('https://api.blink.store/v1/subscriptions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blink.store/v1/subscriptions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'variant_id' => '<string>',
    'product_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-store-id: <x-store-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blink.store/v1/subscriptions/{id}"

	payload := strings.NewReader("{\n  \"variant_id\": \"<string>\",\n  \"product_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-store-id", "<x-store-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.blink.store/v1/subscriptions/{id}")
  .header("x-store-id", "<x-store-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variant_id\": \"<string>\",\n  \"product_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blink.store/v1/subscriptions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-store-id"] = '<x-store-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variant_id\": \"<string>\",\n  \"product_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "store_id": "<string>",
    "product_id": "<string>",
    "variant_id": "<string>",
    "status": "<string>",
    "current_period_end": "2023-11-07T05:31:56Z",
    "cancel_at_period_end": true,
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "stripe_subscription_id": "<string>",
    "stripe_customer_id": "<string>",
    "product": {
      "id": "<string>",
      "name": "<string>",
      "pricing_model": "standard",
      "subscription_interval": "day",
      "subscription_interval_count": 2
    },
    "variant": {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "subscription_interval": "day",
      "subscription_interval_count": 2
    },
    "customer_id": "<string>",
    "custom_data": {},
    "is_test": true
  }
}

Getting Started

Developer Tools

Core

Financials

Growth & Marketing

Webhooks & Events

OAuth 2.0

Update or swap a subscription

Headers

Path Parameters

Body

Response