Billing & Orders

Get paginated past or upcoming orders report

Retrieves a paginated list of subscription billing attempts filtered by status (SUCCESS, FAILURE, QUEUED, SKIPPED) with optional contract filtering.

Key Features:

Status Filtering: Filter by SUCCESS (past successful orders), FAILURE (failed billing attempts), QUEUED (upcoming scheduled orders), or SKIPPED (intentionally skipped orders)
Contract Filtering: Optional filtering by specific subscription contract ID
Pagination Support: Returns paginated results with page headers
Order History: Access complete billing attempt history

Status Values:

SUCCESS: Completed successful billing attempts (past orders)
FAILURE: Failed billing attempts that need attention
QUEUED: Upcoming scheduled billing attempts (future orders)
SKIPPED: Manually or automatically skipped billing attempts

Use Cases:

Generate customer order history reports
Display upcoming scheduled deliveries
Track failed billing attempts for recovery
Export subscription order data for analysis
Monitor skipped orders and cancellations

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

GET

api

external

subscription-billing-attempts

past-orders

report

Get paginated past or upcoming orders report

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report

import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report")

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

request = Net::HTTP::Get.new(url)

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

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "detail": "Invalid status provided",
  "errorKey": "validation_error",
  "status": 400,
  "title": "Bad Request"
}

[
  {
    "retryingNeeded": true,
    "shop": "my-store.myshopify.com",
    "applyUsageCharge": true,
    "attemptCount": 1,
    "attemptTime": "2023-11-07T05:31:56Z",
    "billingAttemptId": "<string>",
    "billingAttemptResponseMessage": "<string>",
    "billingDate": "2023-11-07T05:31:56Z",
    "contractId": 67890,
    "graphOrderId": "<string>",
    "id": 12345,
    "orderAmount": 29.99,
    "orderAmountUSD": 123,
    "orderId": 123,
    "orderName": "#1001",
    "orderNote": "<string>",
    "progressAttemptCount": 123,
    "recurringChargeId": 123,
    "transactionRate": 123,
    "upgradeDowngradeBilling": true,
    "variantList": [
      {
        "image": "<string>",
        "productId": "<string>",
        "productTitle": "<string>",
        "quantity": 123,
        "sellingPlanId": "<string>",
        "title": "<string>",
        "variantId": 123
      }
    ]
  }
]

Headers

X-API-Key

string

Query Parameters

api_key

string

API Key (Deprecated - Use Header X-API-Key instead)

contractId

integer<int64>

Filter by contract Id

status

string

required

Filter by status

pageable

object

required

Pagination parameters (page number and size)

Show child attributes

Response

Billing attempts successfully retrieved

retryingNeeded

boolean

required

shop

string

required

Shop domain identifier

Example:

"my-store.myshopify.com"

applyUsageCharge

boolean

attemptCount

integer<int32>

Number of billing retry attempts

Example:

1

attemptTime

string<date-time>

billingAttemptId

string

Shopify billing attempt ID

billingAttemptResponseMessage

string

billingDate

string<date-time>

Scheduled billing date for this attempt

contractId

integer<int64>

Associated subscription contract ID

Example:

67890

graphOrderId

string

integer<int64>

Unique identifier of the billing attempt record

Example:

12345

orderAmount

number<double>

Total order amount

Example:

29.99

orderAmountUSD

number<double>

orderId

integer<int64>

Shopify order ID if billing was successful

orderName

string

Shopify order name/number

Example:

"#1001"

orderNote

string

Order note or special instructions

progressAttemptCount

integer<int32>

recurringChargeId

integer<int64>

securityChallengeSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

EMAIL_SETTINGS_DISABLED,

CONTRACT_CANCELLED

status

enum<string>

Current status of the billing attempt

Available options:

SUCCESS,

FAILURE,

REQUESTING,

PROGRESS,

QUEUED,

SKIPPED,

SOCIAL_CONNECTION_NULL,

CONTRACT_CANCELLED,

CONTRACT_ENDED,

CONTRACT_PAUSED,

AUTO_CHARGE_DISABLED,

SKIPPED_DUNNING_MGMT,

SECURITY_CHALLENGE,

SHOPIFY_EXCEPTION

transactionFailedEmailSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

EMAIL_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED

transactionFailedSmsSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

SMS_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED,

PHONE_NUMBER_EMPTY

transactionRate

number<double>

upcomingOrderEmailSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

EMAIL_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED,

STOP_FROM_CONTRACT,

CONTRACT_PAUSED

upcomingOrderSmsSentStatus

enum<string>

Available options:

SENT,

UNSENT,

FAILED,

SMS_SETTINGS_DISABLED,

CUSTOMER_PAYMENT_EMPTY,

CONTRACT_CANCELLED,

STOP_FROM_CONTRACT,

CONTRACT_PAUSED,

PHONE_NUMBER_EMPTY

upgradeDowngradeBilling

boolean

usageChargeStatus

enum<string>

Available options:

SUCCESS,

FAILED,

TO_BE_TRIED

variantList

object[]

Show child attributes

Get past orders

Skip upcoming subscription order

Get paginated past or upcoming orders report

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report

import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/subscription-billing-attempts/past-orders/report")

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

request = Net::HTTP::Get.new(url)

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

{
  "retryingNeeded": true,
  "shop": "my-store.myshopify.com",
  "applyUsageCharge": true,
  "attemptCount": 1,
  "attemptTime": "2023-11-07T05:31:56Z",
  "billingAttemptId": "<string>",
  "billingAttemptResponseMessage": "<string>",
  "billingDate": "2023-11-07T05:31:56Z",
  "contractId": 67890,
  "graphOrderId": "<string>",
  "id": 12345,
  "orderAmount": 29.99,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "#1001",
  "orderNote": "<string>",
  "progressAttemptCount": 123,
  "recurringChargeId": 123,
  "transactionRate": 123,
  "upgradeDowngradeBilling": true,
  "variantList": [
    {
      "image": "<string>",
      "productId": "<string>",
      "productTitle": "<string>",
      "quantity": 123,
      "sellingPlanId": "<string>",
      "title": "<string>",
      "variantId": 123
    }
  ]
}

{
  "detail": "Invalid status provided",
  "errorKey": "validation_error",
  "status": 400,
  "title": "Bad Request"
}

[
  {
    "retryingNeeded": true,
    "shop": "my-store.myshopify.com",
    "applyUsageCharge": true,
    "attemptCount": 1,
    "attemptTime": "2023-11-07T05:31:56Z",
    "billingAttemptId": "<string>",
    "billingAttemptResponseMessage": "<string>",
    "billingDate": "2023-11-07T05:31:56Z",
    "contractId": 67890,
    "graphOrderId": "<string>",
    "id": 12345,
    "orderAmount": 29.99,
    "orderAmountUSD": 123,
    "orderId": 123,
    "orderName": "#1001",
    "orderNote": "<string>",
    "progressAttemptCount": 123,
    "recurringChargeId": 123,
    "transactionRate": 123,
    "upgradeDowngradeBilling": true,
    "variantList": [
      {
        "image": "<string>",
        "productId": "<string>",
        "productTitle": "<string>",
        "quantity": 123,
        "sellingPlanId": "<string>",
        "title": "<string>",
        "variantId": 123
      }
    ]
  }
]