Billing & Orders
Update billing attempt
Updates a membership billing attempt record from the customer portal.
PUT
/
memberships
/
cp
/
api
/
subscription-billing-attempts
Update billing attempt
curl --request PUT \
--url https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts \
--header 'Content-Type: application/json' \
--data '
{
"retryingNeeded": true,
"shop": "my-store.myshopify.com"
}
'import requests
url = "https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts"
payload = {
"retryingNeeded": True,
"shop": "my-store.myshopify.com"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({retryingNeeded: true, shop: 'my-store.myshopify.com'})
};
fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts';
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({retryingNeeded: true, shop: 'my-store.myshopify.com'})
};
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://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'retryingNeeded' => true,
'shop' => 'my-store.myshopify.com'
]),
CURLOPT_HTTPHEADER => [
"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://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts"
payload := strings.NewReader("{\n \"retryingNeeded\": true,\n \"shop\": \"my-store.myshopify.com\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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))
}require 'uri'
require 'net/http'
url = URI("https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"retryingNeeded\": true,\n \"shop\": \"my-store.myshopify.com\"\n}"
response = http.request(request)
puts response.read_body{
"attemptTime": "2023-11-07T05:31:56Z",
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 67890,
"graphOrderId": "<string>",
"id": 12345,
"orderAmount": 29.99,
"orderId": 123,
"orderName": "#1001",
"orderNote": "<string>",
"retryingNeeded": true,
"shop": "my-store.myshopify.com",
"status": "SUCCESS",
"upgradeDowngradeBilling": true,
"variantList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
}Body
application/json
Response
200 - */*
OK
⌘I
Update billing attempt
curl --request PUT \
--url https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts \
--header 'Content-Type: application/json' \
--data '
{
"retryingNeeded": true,
"shop": "my-store.myshopify.com"
}
'import requests
url = "https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts"
payload = {
"retryingNeeded": True,
"shop": "my-store.myshopify.com"
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({retryingNeeded: true, shop: 'my-store.myshopify.com'})
};
fetch('https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts';
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({retryingNeeded: true, shop: 'my-store.myshopify.com'})
};
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://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'retryingNeeded' => true,
'shop' => 'my-store.myshopify.com'
]),
CURLOPT_HTTPHEADER => [
"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://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts"
payload := strings.NewReader("{\n \"retryingNeeded\": true,\n \"shop\": \"my-store.myshopify.com\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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))
}require 'uri'
require 'net/http'
url = URI("https://www.myshop.com/apps/memberships/cp/api/subscription-billing-attempts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"retryingNeeded\": true,\n \"shop\": \"my-store.myshopify.com\"\n}"
response = http.request(request)
puts response.read_body{
"attemptTime": "2023-11-07T05:31:56Z",
"billingAttemptId": "<string>",
"billingDate": "2023-11-07T05:31:56Z",
"contractId": 67890,
"graphOrderId": "<string>",
"id": 12345,
"orderAmount": 29.99,
"orderId": 123,
"orderName": "#1001",
"orderNote": "<string>",
"retryingNeeded": true,
"shop": "my-store.myshopify.com",
"status": "SUCCESS",
"upgradeDowngradeBilling": true,
"variantList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
}