Change subscription settings - Shoply Documentation

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.subscriptions.updateSettings();

curl --request PATCH \
  --url https://api.shoply.gg/v1/stores/{storeId}/subscriptions/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancelOn": true,
  "undoOn": true,
  "pauseOn": true,
  "pauseDays": 30,
  "pausesAYear": 2,
  "remindersOn": true,
  "reminderDays": [
    7,
    3,
    1
  ],
  "graceDays": 3,
  "revokeOn": true,
  "autoOn": true,
  "cardChangeOn": true,
  "chargeTries": 3
}
'

package main

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

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/subscriptions/settings"

	payload := strings.NewReader("{\n  \"cancelOn\": true,\n  \"undoOn\": true,\n  \"pauseOn\": true,\n  \"pauseDays\": 30,\n  \"pausesAYear\": 2,\n  \"remindersOn\": true,\n  \"reminderDays\": [\n    7,\n    3,\n    1\n  ],\n  \"graceDays\": 3,\n  \"revokeOn\": true,\n  \"autoOn\": true,\n  \"cardChangeOn\": true,\n  \"chargeTries\": 3\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.shoply.gg/v1/stores/{storeId}/subscriptions/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancelOn\": true,\n  \"undoOn\": true,\n  \"pauseOn\": true,\n  \"pauseDays\": 30,\n  \"pausesAYear\": 2,\n  \"remindersOn\": true,\n  \"reminderDays\": [\n    7,\n    3,\n    1\n  ],\n  \"graceDays\": 3,\n  \"revokeOn\": true,\n  \"autoOn\": true,\n  \"cardChangeOn\": true,\n  \"chargeTries\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/subscriptions/settings")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancelOn\": true,\n  \"undoOn\": true,\n  \"pauseOn\": true,\n  \"pauseDays\": 30,\n  \"pausesAYear\": 2,\n  \"remindersOn\": true,\n  \"reminderDays\": [\n    7,\n    3,\n    1\n  ],\n  \"graceDays\": 3,\n  \"revokeOn\": true,\n  \"autoOn\": true,\n  \"cardChangeOn\": true,\n  \"chargeTries\": 3\n}"

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

{
  "success": true,
  "message": null,
  "code": null,
  "data": {
    "cancelOn": true,
    "cancelMode": "end",
    "undoOn": true,
    "pauseOn": true,
    "pauseDays": 30,
    "pausesAYear": 2,
    "remindersOn": true,
    "reminderDays": [
      7,
      3
    ],
    "graceDays": 3,
    "revokeOn": true,
    "autoOn": true,
    "cardChangeOn": true,
    "chargeTries": 3
  },
  "meta": {
    "plans": [
      {
        "variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
        "productId": "f463e265-097a-4235-bc2f-5239b19a9874",
        "productName": "Northwind Pro",
        "variantName": "1 month",
        "price": 9.99,
        "every": 1,
        "unit": "month",
        "running": 0,
        "automatic": 0
      }
    ],
    "limits": {
      "maxPlans": 200,
      "minDays": 7,
      "maxDays": 365,
      "maxReminders": 5,
      "maxReminderDay": 30,
      "maxGraceDays": 30,
      "maxPauseDays": 365,
      "maxPausesAYear": 12,
      "maxChargeTries": 5
    }
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

PATCH

stores

{storeId}

subscriptions

settings

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const result = await shoply.subscriptions.updateSettings();

curl --request PATCH \
  --url https://api.shoply.gg/v1/stores/{storeId}/subscriptions/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancelOn": true,
  "undoOn": true,
  "pauseOn": true,
  "pauseDays": 30,
  "pausesAYear": 2,
  "remindersOn": true,
  "reminderDays": [
    7,
    3,
    1
  ],
  "graceDays": 3,
  "revokeOn": true,
  "autoOn": true,
  "cardChangeOn": true,
  "chargeTries": 3
}
'

package main

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

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/subscriptions/settings"

	payload := strings.NewReader("{\n  \"cancelOn\": true,\n  \"undoOn\": true,\n  \"pauseOn\": true,\n  \"pauseDays\": 30,\n  \"pausesAYear\": 2,\n  \"remindersOn\": true,\n  \"reminderDays\": [\n    7,\n    3,\n    1\n  ],\n  \"graceDays\": 3,\n  \"revokeOn\": true,\n  \"autoOn\": true,\n  \"cardChangeOn\": true,\n  \"chargeTries\": 3\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.shoply.gg/v1/stores/{storeId}/subscriptions/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancelOn\": true,\n  \"undoOn\": true,\n  \"pauseOn\": true,\n  \"pauseDays\": 30,\n  \"pausesAYear\": 2,\n  \"remindersOn\": true,\n  \"reminderDays\": [\n    7,\n    3,\n    1\n  ],\n  \"graceDays\": 3,\n  \"revokeOn\": true,\n  \"autoOn\": true,\n  \"cardChangeOn\": true,\n  \"chargeTries\": 3\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/subscriptions/settings")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancelOn\": true,\n  \"undoOn\": true,\n  \"pauseOn\": true,\n  \"pauseDays\": 30,\n  \"pausesAYear\": 2,\n  \"remindersOn\": true,\n  \"reminderDays\": [\n    7,\n    3,\n    1\n  ],\n  \"graceDays\": 3,\n  \"revokeOn\": true,\n  \"autoOn\": true,\n  \"cardChangeOn\": true,\n  \"chargeTries\": 3\n}"

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

{
  "success": true,
  "message": null,
  "code": null,
  "data": {
    "cancelOn": true,
    "cancelMode": "end",
    "undoOn": true,
    "pauseOn": true,
    "pauseDays": 30,
    "pausesAYear": 2,
    "remindersOn": true,
    "reminderDays": [
      7,
      3
    ],
    "graceDays": 3,
    "revokeOn": true,
    "autoOn": true,
    "cardChangeOn": true,
    "chargeTries": 3
  },
  "meta": {
    "plans": [
      {
        "variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
        "productId": "f463e265-097a-4235-bc2f-5239b19a9874",
        "productName": "Northwind Pro",
        "variantName": "1 month",
        "price": 9.99,
        "every": 1,
        "unit": "month",
        "running": 0,
        "automatic": 0
      }
    ],
    "limits": {
      "maxPlans": 200,
      "minDays": 7,
      "maxDays": 365,
      "maxReminders": 5,
      "maxReminderDay": 30,
      "maxGraceDays": 30,
      "maxPauseDays": 365,
      "maxPausesAYear": 12,
      "maxChargeTries": 5
    }
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

Authorizations

Authorization

string

header

required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key

string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId

string

required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Body

application/json

cancelOn

boolean

Whether a buyer may cancel from their customer panel.

cancelMode

enum<string>

When a buyer's cancellation takes effect: when what was paid for runs out, or straight away.

Available options:

end,

now

undoOn

boolean

Whether a buyer may take a cancellation back before it takes effect.

pauseOn

boolean

Whether a buyer may pause from their customer panel.

pauseDays

integer

The longest a buyer may pause for, from 1 to 365 days.

Example:

30

pausesAYear

integer

How many times in a year a buyer may pause, from 1 to 12.

Example:

2

remindersOn

boolean

Whether the buyer is reminded before a renewal is due.

reminderDays

integer[]

How many days before it is due each reminder goes: up to 5, each from 1 to 30.

Example:

[7, 3, 1]

graceDays

integer

How long a renewal may go unpaid after the period runs out before the subscription ends, from 0 to 30 days.

Example:

3

revokeOn

boolean

Whether an ended or paused subscription's keys and files are hidden from its buyer.

autoOn

boolean

Whether a card paid with through Stripe, Authorize.net, Tagada, Mollie, MONEI, Adyen or Square, or through NMI where its Keep Cards for Subscriptions is on, is kept and each renewal charged to it by itself. Off, every renewal is paid by an emailed link.

cardChangeOn

boolean

Whether a renewal a buyer pays by its link with another card keeps that card, and a buyer whose card is kept through Stripe may give another on Stripe's own page.

chargeTries

integer

How many times a declined card is tried, one a day while the grace days last, from 1 to 5.

Example:

3

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object

Show child attributes