subscriptions

Bulk retry subscriptions

Queue an immediate retry on each of a set of past-due subscriptions, for the Subscription Billing day drawer’s bulk retry.

Every token is answered. A token is queued when a retry is now in hand for it, skipped when the subscription is known but cannot take one — with the reason — or failed when no subscription of that token belongs to the caller. A skip is not an error: a renewal that is not past due, is not due yet, or sits on a payment method the processor told us to stop charging is reported as passed over rather than as a fault, so an operator can see which of a day’s renewals will not be charged.

Retrying the same subscription twice in quick succession queues one charge. The repeat is still reported as queued, because a retry is in hand for it.

POST

api

subscriptions

bulk_retry

Bulk retry subscriptions

curl --request POST \
  --url https://api.fluid.app/api/subscriptions/bulk_retry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokens": [
    "sb_primex_active_001",
    "sb_primex_past_due_002"
  ]
}
'

import requests

url = "https://api.fluid.app/api/subscriptions/bulk_retry"

payload = { "tokens": ["sb_primex_active_001", "sb_primex_past_due_002"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tokens: ['sb_primex_active_001', 'sb_primex_past_due_002']})
};

fetch('https://api.fluid.app/api/subscriptions/bulk_retry', 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.fluid.app/api/subscriptions/bulk_retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tokens' => [
        'sb_primex_active_001',
        'sb_primex_past_due_002'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.fluid.app/api/subscriptions/bulk_retry"

	payload := strings.NewReader("{\n  \"tokens\": [\n    \"sb_primex_active_001\",\n    \"sb_primex_past_due_002\"\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.fluid.app/api/subscriptions/bulk_retry")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokens\": [\n    \"sb_primex_active_001\",\n    \"sb_primex_past_due_002\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/subscriptions/bulk_retry")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokens\": [\n    \"sb_primex_active_001\",\n    \"sb_primex_past_due_002\"\n  ]\n}"

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

{
  "queued_tokens": [
    "<string>"
  ],
  "skipped_tokens": [
    {
      "token": "<string>",
      "reason": "not_past_due",
      "error": "<string>"
    }
  ],
  "failed_tokens": [
    {
      "token": "<string>",
      "error": "<string>"
    }
  ],
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Body

application/json

The subscription tokens to retry.

tokens

string[]

required

Subscription tokens. Duplicates are collapsed before the batch runs, and the deduplicated count is what the maximum is applied to.

Required array length: 1 - 500 elements

Example:

[
  "sb_primex_active_001",
  "sb_primex_past_due_002"
]

Response

Every token answered as queued, skipped, or failed

One entry per token sent, across three lists.

queued_tokens

string[]

required

Subscriptions a retry is now in hand for.

skipped_tokens

object[]

required

Subscriptions passed over, each carrying why.

Show child attributes

failed_tokens

object[]

required

Tokens that resolved to no subscription of the caller's.

Show child attributes

meta

object | null

required

Show child attributes

Bulk retry subscriptions

curl --request POST \
  --url https://api.fluid.app/api/subscriptions/bulk_retry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokens": [
    "sb_primex_active_001",
    "sb_primex_past_due_002"
  ]
}
'

import requests

url = "https://api.fluid.app/api/subscriptions/bulk_retry"

payload = { "tokens": ["sb_primex_active_001", "sb_primex_past_due_002"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tokens: ['sb_primex_active_001', 'sb_primex_past_due_002']})
};

fetch('https://api.fluid.app/api/subscriptions/bulk_retry', 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.fluid.app/api/subscriptions/bulk_retry",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tokens' => [
        'sb_primex_active_001',
        'sb_primex_past_due_002'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.fluid.app/api/subscriptions/bulk_retry"

	payload := strings.NewReader("{\n  \"tokens\": [\n    \"sb_primex_active_001\",\n    \"sb_primex_past_due_002\"\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.fluid.app/api/subscriptions/bulk_retry")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokens\": [\n    \"sb_primex_active_001\",\n    \"sb_primex_past_due_002\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/subscriptions/bulk_retry")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokens\": [\n    \"sb_primex_active_001\",\n    \"sb_primex_past_due_002\"\n  ]\n}"

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

{
  "queued_tokens": [
    "<string>"
  ],
  "skipped_tokens": [
    {
      "token": "<string>",
      "reason": "not_past_due",
      "error": "<string>"
    }
  ],
  "failed_tokens": [
    {
      "token": "<string>",
      "error": "<string>"
    }
  ],
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "error": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Member endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Bulk retry subscriptions

Authorizations

Body

Response