NAV
Axios Fetch jQuery

INTRODUCTION

About the Theme Engine

The customer portal is powered by a theme engine which allows you to customize the views to your needs. It is composed of a set of endpoints that provide specific functionality. Each endpoint is associated with a required asset that you can customize to your liking. The endpoint also has a set of objects that can be used to customize the user experience.

The Theme Engine will be an update to the Customer Portal which will allow you to completely customize the pages their customers use to manage their subscription beyond simply adding HTML, CSS and JavaScript.

You'll have access to use Jinja code and an array of objects and filters like Shopify and create a truly unique, personal, and branded experience.

A visual overview of the Recharge object hierarchy

Token Security

Recharge supports the usage of a special, expiring token as a way to strengthen a customer's account security.

How does it work?

When a user signs in to manage their account, a token will be generated, assigned to their account, and appened to the URL. This token will be used while they navigate through pages and make requests. If an attempt is made to access an account without either a token or using an unauthorized-token, the request will be denied and a redirect will occur to the login/token request page.

Recharge will handle generating a token, emailing it, and verifying authorized tokens against the customer account. It will even perform redirects if an incorrect token is used.

Request objects

Example querying a customer from a store

(async () => {
  let schema = '{ "customer": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying payment sources for a customer

(async () => {
  let schema = '{ "payment_sources": [] }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "payment_sources": [] }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "payment_sources": [] }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying all addresses for a customer

(async () => {
  let schema = '{ "addresses": [] }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "addresses": [] }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "addresses": [] }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying specific address

(async () => {
  let schema = '{ "address": { "id": <int:address_id> } }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "address": { "id": <int:address_id> } }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "address": { "id": <int:address_id> } }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying all subscriptions for a customer

(async () => {
  let schema = '{ "subscriptions": [] }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "subscriptions": [] }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "subscriptions": [] }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying specific subscription

(async () => {
  let schema = '{ "subscription": { "id": <int:subscription_id> } }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "subscription": { "id": <int:subscription_id> } }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "subscription": { "id": <int:subscription_id> } }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying all orders for a customer

(async () => {
  let schema = '{ "orders": [] }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "orders": [] }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "orders": [] }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Example querying specific order

(async () => {
  let schema = '{ "order": { "id": <int:order_id> } }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "order": { "id": <int:order_id> } }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "order": { "id": <int:order_id> } }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

Main purpose of Request objects feature is that Theme Editor developers can request API objects through the json. Any structure can be pulled and it will use Recharge API.

Property Schema Definition
Customer { schema: '{ "customer": {} }' } Example of querying a customer.
Payment sources { schema: '{ "payment_sources": [] }' } Example of querying all payment sources for a customer.
Payment methods { schema: '{ "payment_methods": [] }' } Example of querying all payment methods for a customer. Replaces payment sources from Novum 4.
Payment method { schema: '{ "payment_methods": [ "id": <int:payment_method_id> ] }' } Example of querying a specific payment method for a customer. Replaces payment sources from Novum 4.
Addresses { schema: '{ "addresses": [] }' } Example of querying all addresses for a customer.
Address { schema: '{ "address": { "id": <int:address_id> } }' } Example of querying a specific address by address id for a customer.
Shipping Addresses { schema: '{ "addresses": [] }' } Example of querying all shipping addresses for a customer. Replaces Addresses from Novum 4.
Shipping Address { schema: '{ "address": { "id": <int:address_id> } }' } Example of querying a specific address by address id for a customer. Replaces Address from Novum 4.
Subscriptions { schema: '{ "subscriptions": [] }' } Example of querying all subscriptions for a customer.
Subscription { schema: '{ "subscription": { "id": <int:subscription_id> } }' } Example of querying subscription by subscription id for a customer.
Subscription bundle selections { schema: '{ "subscription": { "id": <int:subscription_id>, "bundle_selections": {} } }' } Example of querying subscription and its bundle selections by subscription id.
Orders { schema: '{ "orders": [] }' } Example of querying all orders for a customer.
Order { schema: '{ "order": { "id": <int:order_id> } }' } Example of querying order by order id for a customer.

Customer endpoint

Filter Schema
show_customer_url { schema: '{ "customer": {}, "payment_sources": [] }' }
update_customer_url { schema: '{ "customer": {} }' }
update_card_url { schema: '{ "customer": {} }' }
update_customer_card_form { schema: '{ "customer": {} }' }

Payment Methods endpoint (valid from Novum 4 only)

Filter Schema
payment_methods_list_url { schema: '{ "customer": {}, "payment_methods": [] }' }
show_payment_method_url { schema: '{ "customer": {}, "payment_methods": [ "id": <int:payment_method_id> ] }' }
update_payment_method_url { schema: '{ "customer": {}, "payment_methods": [ "id": <int:payment_method_id> ] }' }
payment_method_address_url { schema: '{ "customer": {}, "payment_methods": [ "payment_method_id": <int:payment_method_id> ] }' }

Delivery schedule endpoints

Filter Schema
delivery_schedule_url { schema: '{ "customer": {}, "delivery_schedule": [] }' }

Addresses endpoints

Filter Schema
list_addresses_url { schema: '{ "customer": {} }, "addresses": [] }' }
create_address_url { schema: '{ "customer": {} }' }
show_address_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }
update_address_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }

Shipping addresses endpoints

Filter Schema
list_addresses_url { schema: '{ "customer": {} }, "addresses": [] }' }
create_address_url { schema: '{ "customer": {} }' }
show_shipping_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }
update_shipping_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }

Subscriptions endpoints

Filter Schema
list_subscriptions_url { schema: '{ "customer": {}, "addresses": [], "subscriptions": [] }' }
create_subscription_url { schema: '{ "customer": {}, "addresses": [] }' }
show_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }
update_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }

Subscription action endpoints

Filter Schema
activate_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }
skip_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }
unskip_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }
subscription_charge_date_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }
delay_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }

Subscription cancel endpoints

Filter Schema
retention_strategy_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> }, "retention_strategies": [] }' }
cancel_subscription_url { schema: '{ "customer": {}, "subscription": { "id": <int:subscription_id> } }' }

Product search endpoints

Filter Schema
product_search_url { schema: '{ "customer": {}, "products": [] }' }

Discount endpoints

Filter Schema
apply_discount_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }
apply_discount_to_address_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }
remove_discount_from_address_url { schema: '{ "customer": {}, "address": { "id": <int:address_id> } }' }

Order endpoints

Filter Schema
list_orders_url { schema: '{ "customer": {}, "orders": [] }' }
show_order_url { schema: '{ "customer": {}, "order": { "id": <int:order_id> } }' }

One-time endpoints

Filter Schema
delete_one_time_product_url { schema: '{ "customer": {}, "onetime": { "id": <int:onetime_id> } }' }

CORE RESOURCES

Addresses

EXAMPLE USING PROPERTIES

{{ address.first_name }} {{ address.last_name }} <br>
{{ address.company }} <br>
{{ address.address1 }} {{ address.address2 }} <br>
{{ address.zip }} {{ address.city }} {{ address.province }} <br>
{{ address.country }} <br>
{{ address.phone }}

EXAMPLE OUTPUT

Johnny Charge
Recharge Payments
6024 St. Michaels 204
90105 Los Sngeles California
United States
0123123210

Addresses represent one of the many shipping locations a customer may have. Subscriptions are tied to a given address, and each customer can have multiple address objects (many-to-one) in the relationship.

Getting an address

EXAMPLE INPUT

{% for address in addresses %}
  {{ address.address1 }}
{% endfor %}

{{ subscription.address.first_name }}

EXAMPLE OUTPUT

6048 Manning Avenue
101 Dunlap Crossing Road
14 Main Street #10

Jimmy

You can access all address objects by looping over the addresses parent object, or individually through a associative objects, such as Subscriptions.

Address routes

Routes are used to retrieve, create, or modify existing data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


GET /tools/recurring/portal/<string:customer_hash>/addresses

This endpoint renders a template with a list of addresses for customer. route details

GET /tools/recurring/portal/<string:customer_hash>/addresses/new

This endpoint renders a template with a form for creating new address for customer. route details

POST /tools/recurring/portal/<string:customer_hash>/addresses

This enpoint creates a new address for customer. route details

GET /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>

This endpoint renders a template with form for updating customer's address. route details

POST /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>

This enpoint updates an existing address for customer. route details

POST /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>/charges/skip

This endpoint skips one or more subscriptions associated with an address. route details

POST /tools/recurring/portal/<string:customer_hash>/addresses/merge

This endpoint merges up to 10 different addresses per request into a single address. route details

Address object

Object contains the different variables of information you may want to access when rendering an object. Some objects will even contain child properties, such as address.discount.code.

Property Definition
address.address1
string		 "address.address1": "101 Washington Street"
The street associated with the address.
address.address2
string		 "address.address2": "Suite 101"
Any additional information associated with the address.
address.cart_note
string		 "address.cart_note": ""
The note that that will be passed to the “note” field of orders made within the address.
address.city
string		 "address.city": "Los Angeles"
The city associated with the address.
address.company
string		 "address.company": "Recharge"
The company associated with the address.
address.country
string		 "address.country": "United States"
The country associated with the address.
address.created_at
string		 "address.created_at": "2018-02-21T11:46:01"
The date and time when the address was created.
address.customer_id
number		 "address.customer_id": 8187626
Unique numeric identifier for the customer associated with the address.
address.deleted_at
string		 "address.deleted_at": null
The date and time when the address was deleted.
address.discount
object		 "applies_to": null,
"applies_to_id": null,
"applies_to_product_type":"SUBSCRIPTION",
"applies_to_resource": null,
"channel_settings": {
"api": {
can_apply: true
},
"checkout_page": {
can_apply: true
},
"customer_portal": {
can_apply: true
},
"merchant_portal": {
can_apply: true
}
},
"code": "test123",
"created_at": "2019-07-03T10:06:47",
"discount_type": "percentage",
"duration": "single_use",
"duration_usage_limit": null,
"ends_at": null,
"first_time_customer_restriction": null,
"id": 13350570,
"once_per_customer": true,
"prerequisite_subtotal_min": null,
"starts_at": "2019-07-04T00:00:00",
"status": "enabled",
"times_used": 0,
"updated_at": "2019-07-03T10:06:47",
"usage_limit": null,
"value": 10.0
address.discount_id
number		 "address.discount_id": null
Unique numeric identifier for the discount.
address.first_name
string		 "address.first_name": "John"
The customer’s first name associated with the address.
address.id
number		 "address.id": 7976732
Unique numeric identifier for the address.
address.include
object		 "address.include": {
"payment_methods": []
}
Includes payment methods.
address.last_name
string		 "address.last_name": "Doe"
The customer’s last name associated with the address.
address.note_attributes
array		 "address.note_attributes": []
Extra information that is added to the address. Each array entry must contain a hash with “name” and “value” keys.
address.phone
string		 "address.phone": "3103103101"
The phone number associated with the address.
address.presentment_currency
string		 "address.presentment_currency": "USD"
The currency on the subscription contract in Shopify.
address.province
string		 "address.province": "California"
The state or province associated with the address.
address.shipping_lines_override
string		 "address.shipping_lines_override": null
If shipping rates need to be overridden no matter what settings are in Shopify, then desired shipping rate values needs to be set in this parameter. If this parameter has value null, charge will pull shipping rates from Shopify.
address.updated_at
string		 "address.updated_at": "2019-04-22T09:35:39"
The date and time when the address was last updated.
address.zip
string		 "address.zip": "90025"
The zip or postal code associated with the address.

[GET] - List of addresses

GET /request_objects

(async () => {
  let schema = '{ "addresses": { "discount": { "id": "parent.discount_id" }}, "customer": {}, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
    try {
      const response = await axios(url);
      // Successful request made
      console.log(response.data);
    } catch (error) {
      // Request failed
      console.error(error);
    }
})();

let schema = '{ "addresses": { "discount": { "id": "parent.discount_id" }}, "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "addresses": { "discount": { "id": "parent.discount_id" }}, "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "addresses":[
      {
         "address1":"101 Washington Street",
         "address2":"Suite 101",
         "cart_note":"",
         "city":"Los Angeles",
         "company":"",
         "country":"United States",
         "created_at":"2018-10-09T08:38:33",
         "customer_id":8187626,
         "deleted_at": null,
         "discount": {
            "applies_to": null,
            "applies_to_id": null,
            "applies_to_product_type": "SUBSCRIPTION",
            "applies_to_resource": null,
            "channel_settings": {
               "api": {
                  "can_apply": true
                  },
               "checkout_page": {
                  "can_apply": true
                  },
               "customer_portal": {
                  "can_apply": true
                  },
               "merchant_portal": {
                  "can_apply": true
                  }
            },
            "code": "test123",
            "created_at": "2019-07-03T10:06:47",
            "discount_type": "percentage",
            "duration": "single_use",
            "duration_usage_limit": null,
            "ends_at": null,
            "external_discount_id":null,
            "external_discount_source":null,
            "first_time_customer_restriction": null,
            "id": 13350570,
            "once_per_customer": true,
            "prerequisite_subtotal_min": null,
            "starts_at": "2019-07-04T00:00:00",
            "status": "enabled",
            "times_used": 0,
            "updated_at": "2019-07-03T10:06:47",
            "usage_limit": null,
            "value": 10.0
         },
         "discount_id":13350570,
         "first_name":"John",
         "id":18586680,
         "include": {
            "payment_methods": []
         },
         "last_name":"Doe",
         "note_attributes":[],
         "phone":"5551231234",
         "presentment_currency": "USD",
         "province":"California",
         "shipping_lines_override":null,
         "updated_at":"2019-03-22T16:23:33",
         "zip":"90025"
      },
      {
         "address1":"987 Bluebird Street",
         "address2":"APT 9",
         "cart_note":"",
         "city":"Los Angeles",
         "company":"Recharge",
         "country":"United States",
         "created_at":"2018-02-21T11:46:01",
         "customer_id":8187626,
         "deleted_at": null,
         "discount": {},
         "discount_id":null,
         "first_name":"John",
         "id":7976732,
         "include": {
            "payment_methods": []
         },
         "last_name":"Doe",
         "note_attributes":[],
         "phone":"5551231234",
         "province":"California",
         "shipping_lines_override":null,
         "updated_at":"2019-04-22T09:35:39",
         "zip":"90025"
      }
   ],
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "deleted_at": null,
      "email":"johndoe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "phone": "+12394121332"
      "shopify_customer_id":"391100760128",
      "customer.tax_exempt": false,
      "updated_at":"2019-04-30T15:11:43"
   },
   "settings":{
      "customer_portal":{
         "collection_ids": [],
         "custom_code":{
            "backend_portal": "#rc_subscriptions__items__recurring_price{display:none!important;}",
            "credit_cart_update_page": "",
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "enable_membership_programs": false,
         "force_customer_portal_accounts": false,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "membership":{
            "allow_membership_cancellation_after": 0,
            "membership_cancellation_reason_optional": 1
         },
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "show_credits": false,
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_enable_pause_options": true,
            "cancellation_enable_pause_options_values": "{'duration_options':[{'frequency':1,'unit':'months'},{'frequency':1,'unit':'weeks'},{'frequency':1.33320003,'unit':'days'}],'enabled':1,'last_toggled_at':'2023-02-13T17:21:00.521Z'}",
            "cancellation_minimum_order_count":0,
            "cancellation_reason_optional": true,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "multicurrency_enabled": true,
      "shop_id":41575
   },
   "store": {
      "bundles_enabled": true,
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "disabled_currencies_historical": [],
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "enabled_presentment_currencies":[
        "USD"
      ],
      "enabled_presentment_currencies_symbols":[
        {
          "currency": "USD",
          "location": "before",
          "suffix": "",
          "symbol": "$"
        }
      ],
      "external_platform": "shopify",
      "has_preview_customer": true,
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "payment_processor": "stripe",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "subscriptions_enabled": 1,
      "test_mode": true,
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT",
      "use_single_payment_method": 0
   }
}

This endpoint renders a template with a list of addresses for customer.

URL: {{ address_list_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses?token=${window.customerToken}

Template file: addresses.html

Schema: '{ "addresses": { "discount": { "id": "parent.discount_id" }}, "customer": {}, "settings": {}, "store": {} }'

Available template objects:

[GET] - New address form

GET /request_objects

(async () => {
  let schema = '{ "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
    try {
      const response = await axios(url);
      // Successful request made
      console.log(response.data);
    } catch (error) {
      // Request failed
      console.error(error);
    }
})();

let schema = '{ "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"johndoe@test.com",
      "external_sync": null,
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "phone": "+122312324",
      "shopify_customer_id":"391100760128",
      "tax_exempt": false,
      "updated_at":"2019-04-30T15:11:43"
   },
   "shipping_countries":[
      {
         "code":"CA",
         "country_id":37,
         "id":null,
         "name":"Canada",
         "provinces":[
            {
               "code":"PE",
               "id":1940,
               "name":"Prince Edward Island"
            },
            {
               "code":"BC",
               "id":1941,
               "name":"British Columbia"
            },
            ...
         ]
      },
      {
         "code":"SA",
         "country_id":186,
         "id":null,
         "name":"Saudi Arabia",
         "provinces":[

         ]
      },
      ...
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "backend_portal": "#rc_subscriptions__items__recurring_price{display:none!important;}",
            "credit_cart_update_page": "",
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "enable_membership_programs": false,
         "force_customer_portal_accounts": false,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "membership":{
            "allow_membership_cancellation_after": 0,
            "membership_cancellation_reason_optional": 1
         },
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "show_credits": false,
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_enable_pause_options": true,
            "cancellation_enable_pause_options_values": "{'duration_options':[{'frequency':1,'unit':'months'},{'frequency':1,'unit':'weeks'},{'frequency':1.33320003,'unit':'days'}],'enabled':1,'last_toggled_at':'2023-02-13T17:21:00.521Z'}",
            "cancellation_minimum_order_count":0,
            "cancellation_reason_optional": true,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "multicurrency_enabled": true,
      "shop_id":41575
   },
   "store": {
      "bundles_enabled": true,
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "disabled_currencies_historical": [],
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "enabled_presentment_currencies": [
        "USD"
      ],
      "enabled_presentment_currencies_symbols": [
        {
          "currency": "USD",
          "location": "before",
          "suffix": "",
          "symbol": "$"
        }
      ],
      "external_platform": "shopify",
      "has_preview_customer": true,
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "payment_processor": "stripe",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "subscriptions_enabled": 1,
      "test_mode": true,
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT",
      "use_single_payment_method": 0
   }
}

This endpoint renders a template with a form for creating new address for customer.

URL: {{ address_new_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses/new?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses/new?token=${window.customerToken}

Template file: address_new.html

Schema: '{ "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }'

Available template objects:

[POST] - Create new address

POST /addresses

(async () => {
  let url = '{{ address_list_url }}';
  let data = {
    "address1":"101 Washington Street",
    "address2":"Suite 101",
    "city":"Los Angeles",
    "company":"Bootstrap",
    "country":"United States",
    "first_name":"John",
    "last_name":"Doe",
    "phone":"5551231234",
    "province":"California",
    "zip":"90025"
   }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ address_list_url }}';
let data = {
  "address1":"101 Washington Street",
  "address2":"Suite 101",
  "city":"Los Angeles",
  "company":"Bootstrap",
  "country":"United States",
  "first_name":"John",
  "last_name":"Doe",
  "phone":"5551231234",
  "province":"California",
  "zip":"90025"
}
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ address_list_url }}'
  type: 'post',
  dataType: 'json',
  data: {
    "address1":"101 Washington Street",
    "address2":"Suite 101",
    "city":"Los Angeles",
    "company":"Bootstrap",
    "country":"United States",
    "first_name":"John",
    "last_name":"Doe",
    "phone":"5551231234",
    "province":"California",
    "zip":"90025"
   }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"Suite 101",
      "cart_attributes":null,
      "cart_note":null,
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "country_code": "US"
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "discount_id":null,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "note_attributes":null,
      "original_shipping_lines":null,
      "phone":"5551231234",
      "presentment_currency": "USD",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-04-30T15:25:20",
      "zip":"90025"
   }
}

This enpoint creates a new address for customer.

URL: {{ address_list_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses?token=${window.customerToken}

Template file: addresses_new.html

Available template objects:

Arguments accepted:

Property Type
first_name * string
last_name * string
company string
address1 * string
address2 string
city * string
country * string
province * string
zip * string
phone string

* = required

[GET] - Retrieve an address

GET /request_objects

(async () => {
  let schema = '{ "addresses": { "id": <int:address_id>, "discount": {"id": "parent.discount_id"} }, "shipping_countries": [], "customer": {}, "settings": {},
    "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "addresses": { "id": <int:address_id>, "discount": {"id": "parent.discount_id"} }, "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "addresses": { "id": <int:address_id>, "discount": {"id": "parent.discount_id"} }, "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "addresses":{
      "address1":"101 Washington Street",
      "address2":"Suite 101",
      "cart_attributes":null,
      "cart_note":null,
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "deleted_at": null,
      "discount": {
         "applies_to": null,
         "applies_to_id": null,
         "applies_to_product_type": "SUBSCRIPTION",
         "applies_to_resource": null,
         "channel_settings": {
            "api": {
               "can_apply": true
               },
            "checkout_page": {
               "can_apply": true
               },
            "customer_portal": {
               "can_apply": true
               },
            "merchant_portal": {
               "can_apply": true
               }
         },
         "code": "test123",
         "created_at": "2019-07-03T10:06:47",
         "discount_type": "percentage",
         "duration": "single_use",
         "duration_usage_limit": null,
         "ends_at": null,
         "external_discount_id": null,
         "external_discount_source": null,
         "first_time_customer_restriction": null,
         "id": 13350570,
         "once_per_customer": true,
         "prerequisite_subtotal_min": null,
         "starts_at": "2019-07-04T00:00:00",
         "status": "enabled",
         "times_used": 0,
         "updated_at": "2019-07-03T10:06:47",
         "usage_limit": null,
         "value": 10.0
      },
      "discount_id":null,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "note_attributes":null,
      "original_shipping_lines":null,
      "phone":"5551231234",
      "presentment_currency": "USD",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-04-30T15:25:20",
      "zip":"90025"
   },
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"johndoe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-04-30T15:11:43"
   },
   "shipping_countries":[
      {
         "code":"CA",
         "country_id":37,
         "id":null,
         "name":"Canada",
         "provinces":[
            {
               "code":"PE",
               "id":1940,
               "name":"Prince Edward Island"
            },
            {
               "code":"BC",
               "id":1941,
               "name":"British Columbia"
            },
            ...
         ]
      },
      {
         "code":"LY",
         "country_id":123,
         "id":null,
         "name":"Libyan Arab Jamahiriya",
         "provinces":[

         ]
      },
      ...
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with form for updating customer's address.

URL: {{ address_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses/<int:address_id>?token=${window.customerToken}

Template file: address.html

Available template objects:

[POST] - Update an address

POST /addresses/<int:address_id>

(async () => {
  let url = '{{ address_url }}';
  let data = {
    "address1":"101 Washington Street",
    "address2":"204",
    "cart_note":null,
    "city":"Los Angeles",
    "company":"Recharge",
    "country":"United States",
    "first_name":"John",
    "last_name":"Doe",
    "phone":"5551231234",
    "province":"California",
    "zip":"90025"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ address_url }}';
let data = {
  "address1":"101 Washington Street",
  "address2":"204",
  "cart_note":null,
  "city":"Los Angeles",
  "company":"Recharge",
  "country":"United States",
  "first_name":"John",
  "last_name":"Doe",
  "phone":"5551231234",
  "province":"California",
  "zip":"90025"
}
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ address_url }}'
  type: 'post',
  dataType: 'json',
  data: {
    "address1":"101 Washington Street",
    "address2":"204",
    "cart_note":null,
    "city":"Los Angeles",
    "company":"Recharge",
    "country":"United States",
    "first_name":"John",
    "last_name":"Doe",
    "phone":"5551231234",
    "province":"California",
    "zip":"90025"
   }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"204",
      "cart_attributes":null,
      "cart_note":"Updated phone",
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "discount_id":null,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "note_attributes":null,
      "original_shipping_lines":null,
      "phone":"5551231234",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-05-02T14:07:16",
      "zip":"90025"
   }
}

This endpoint updates an existing address for customer.

URL: {{ address_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses/<int:address_id>?token=${window.customerToken}

Template file: address.html

Available template objects:

Arguments accepted:

Property Type
address1 * string
address2 string
cart note string
city * string
company string
country * string
first_name * string
last_name * string
phone string
province * string
zip * string

* = required

[POST] - Update payment method for an address

POST /addresses/<int:address_id>

(async () => {
  let url = '{{ address_url }}';
  let data = {
  "id":"91926701",
  "payment_method_id":"54880892"
}

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ address_url }}';
let data = {
  "id":"91926701",
  "payment_method_id":"54880892"
}
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ address_url }}'
  type: 'post',
  dataType: 'json',
  data: {
    "id":"91926701",
    "payment_method_id":"54880892"
   }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"204",
      "cart_attributes":null,
      "cart_note":"Updated phone",
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "discount_id":null,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "note_attributes":null,
      "original_shipping_lines":null,
      "phone":"5551231234",
      "presentment_currency":"USD",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-05-02T14:07:16",
      "zip":"90025"
   }
}

This endpoint updates payment method for the associated address by moving all subscriptions tied to a selected payment method.

URL: {{ address_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses/<int:address_id>?token=${window.customerToken}

Template file: address.html

Available template objects:

Arguments accepted:

Property Type
id * number
payment_method_id * number

* = required

[POST] - Skip future charges

POST /addresses/<int:address_id>/charges/skip

(async () => {
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/addresses/<int:address_id>/charges/skip?token=${window.customerToken}`;

  let data = {
    date: "2022-09-07",
    subscription_ids: [1234567834, 4567893423]
  };

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/addresses/<int:address_id>/charges/skip?token=${window.customerToken}`;

let data = {
  date: "2022-09-07",
  subscription_ids: [1234567834, 4567893423]
};

let options = {
  method: "post",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify(data)
};

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/addresses/<int:address_id>/charges/skip?token=${window.customerToken}`,
  type: "post",
  dataType: 'json',
  contentType: 'application/json',
  data: JSON.stringify({
    date: "2022-09-07",
    subscription_ids: [1234567834, 4567893423]
  }),
}).done(function (response) {
  // Successful request made
  console.log(response);
}).fail(function (response) {
  // Request failed
  console.error(response);
});

CLICK HERE TO SEE RESPONSE

{
  "charge": {
    "address_id": 18586680,
    "analytics_data": {
      "utm_params": []
    },
    "billing_address": {
      "address1": "101 Washington Street",
      "address2": "204",
      "city": "Los Angeles",
      "company": "Recharge",
      "country_code": "US",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "122211121212",
      "province": "",
      "zip": "90009"
    },
    "client_details": {
      "browser_ip": null,
      "user_agent": null
    },
    "created_at": "2020-02-05T08:45:41",
    "currency": "USD",
    "customer": {
      "email": "test@test.com",
      "external_customer_id": {
        "ecommerce": "1234567890"
      },
      "hash": "63cadb9b9a8853f3218396ded9aff2",
      "id": 78902356
    },
    "discounts": [],
    "error": null,
    "error_type": null,
    "external_order_id": {
      "ecommerce": null
    },
    "external_transaction_id": {
      "payment_processor": null
    },
    "has_uncommited_changes": false,
    "id": 32172457,
    "line_items": [
      { 
        "external_product_id": {
          "ecommerce": "7610487406759"
        },
        "external_variant_id": {
          "ecommerce": "43203789848743"
        },
        "grams": 1230,
        "handle": null,
        "images": {
          "large": "",
          "medium": "",
          "original": "",
          "small": ""
        },
        "properties": [],
        "purchase_item_id": 23456789,
        "purchase_item_type": "subscription",
        "quantity": 1,
        "sku": null,
        "tax_due": "0.00",
        "tax_lines": [],
        "taxable": true,
        "taxable_amount": "100.00",
        "title": "Optimum Nutrition Gold Standard Whey",
        "total_price": "100.00",
        "unit_price": "100.00",
        "unit_price_includes_tax": false,
        "variant_title": ""
      }
    ],
    "note": "next order in sequence 1",
    "note_attributes": [],
    "order_count": 0,
    "payment_processor": "shopify_payments",
    "processed_at": "2023-02-05T08:55:39",
    "retry_date": null,
    "scheduled_at": "2023-02-05T00:00:00",
    "shipping_address": {
      "address1": "101 Washington Street",
      "address2": "",
      "city": "Los Angeles",
      "company": "Recharge",
      "country_code": "US",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "122211121212",
      "province": "California",
      "zip": "90009"
    },
    "shipping_lines": {
      "code": "Standard",
      "price": "0.00",
      "source": "shopify",
      "tax_lines": [],
      "taxable": false,
      "title": "Standard"
    },
    "status": "skipped",
    "subtotal_price": "100.0",
    "tags": "Subscription, Subscription Recurring Order",
    "tax_lines": [],
    "total_discounts": "0.00",
    "total_duties": "0.00",
    "total_line_items_price": "100.00",
    "total_price": "100.00",
    "total_refunds": "0.00",
    "total_tax": "0.00",
    "total_weight_grams": 1230,
    "type": "recurring",
    "updated_at": "2023-02-05T09:55:41"
  }
}

This endpoint skips one or more subscriptions associated to an address. You can skip subscriptions not added to queued charges or skip charges in a future date.

Must pass a date in the future that matches charge interval frequency of the subscription and a list of subscription_ids to skip.

Methods accepted: POST

Embedded Route: /tools/recurring/portal/{{ customer.hash }}/addresses/<int:address_id>/charges/skip?token=${window.customerToken}

Hosted Route: /portal/{{ customer.hash }}/addresses/<int:address_id>/charges/skip?token=${window.customerToken};

Arguments accepted:

Property Type
date * string
subscription_ids * array of numbers

* = required

[POST] - Merge addresses

POST /addresses/merge

(async () => {
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/addresses/merge?token=${window.customerToken}`;

  let data = {
    "delete_source_addresses": false,
    "target_address": { "id": 94777070 },
    "source_addresses": [
      { "id": 94795589 },
      { "id": 94795588 },
      { "id": 94729445 }
    ]
  };

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();


  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/addresses/merge?token=${window.customerToken}`;

  let data = {
    "delete_source_addresses": false,
    "target_address": { "id": 94777070 },
    "source_addresses": [
      { "id": 94795589 },
      { "id": 94795588 },
      { "id": 94729445 }
    ]
  };

  let options = {
    method: 'post'
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
  };

  fetch(url, options)
    .then((response) => response.json())
    .then((response) => {
      // Successful request made
      console.log(response);
    })
    .catch((error) => {
      // Request failed
      console.error(error);
    });



  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/addresses/merge?token=${window.customerToken}`;

  let data = {
    "delete_source_addresses": false,
    "target_address": { "id": 94777070 },
    "source_addresses": [
      { "id": 94795589 },
      { "id": 94795588 },
      { "id": 94729445 }
    ]
  };

  $.ajax({
    url: url,
    type: 'post',
    contentType: 'application/json',
    data: JSON.stringify(data)
  }).done(function (response) {
    // Successful request made
    console.log(response);
  }).fail(function (error) {
    // Request failed
    console.log(error);
  });

CLICK HERE TO SEE RESPONSE

{
   "address": {
      "address1": "101 Washington Street",
      "address2": "Suite 101",
      "city": "Los Angeles",
      "company": "Recharge",
      "country_code": "US",   
      "created_at": "2019-04-30T15:25:20",
      "customer_id": 8187626,
      "discounts": [],
      "first_name": "John",
      "id": 94777070,
      "last_name": "Doe",
      "order_attributes": [],
      "order_note": null,
      "payment_method_id": 84574322,
      "phone": null,
      "presentment_currency": "USD",
      "province": "California",
      "shipping_lines_conserved": [],
      "shipping_lines_override": [],
      "updated_at": "2023-04-30T15:25:20",
      "zip": "90025"
   }
}

This endpoint merges up to 10 different addresses per request into a single address.

Note: If one of the addresses being merged has a different presentment currency, the entire merge will fail and throw an error.

Methods accepted: POST

Embedded Route: /tools/recurring/portal/{{ customer.hash }}/addresses/merge?token={window.customerToken}

Hosted Route: /portal/{{customer.hash}}/addresses/merge?token={window.customerToken}

Property Type Definition
delete_source_addresses boolean Indicates whether the source addresses should be deleted.
next_charge_date string Specifies the next charge date of the associated subscriptions on the target address.
target_address *
target_address.id		 object
number		 The address all of the subscriptions should be moved to.
The ID of the address.
source_addresses *
source_addresses[].id		 array
number		 A list of objects containing the addresses that the subscriptions should move from.

* = required

Shipping Country object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
shipping_country.code
string		 "shipping_country.code": "AU"
The code of the shipping country.
shipping_country.country_id
number		 "shipping_country.country_id": 12
ID of the shipping country.
shipping_country.id
string		 "shipping_country.id": "null"
ID of the shipping country.
shipping_country.name
string		 "shipping_country.name": "Australia"
Name of the shipping country.
shipping_country.provinces
array of objects		 "shipping_country.provinces": [
"code": "ACT",
"id": 2289,
"name": "Australian Capital Territory"
]

Country provinces.

Shipping

Shipping represents the shipping information for the customer.

Shipping routes

Routes are used to retrieve, create, or modify existing data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


GET /tools/recurring/portal/<string:customer_hash>/shipping

This endpoint renders a template with a list of shipping addresses and their associated payment methods for the customer. route details

GET /tools/recurring/portal/<string:customer_hash>/shipping/<int:address_id>/payment_method

This endpoint renders a template with a form for switching the default payment method for an address for the customer. route details

GET /tools/recurring/portal/<string:customer_hash>/shipping/<int:address_id>

This endpoint renders a template with a form for the shipping address. route details

GET /tools/recurring/portal/<string:customer_hash>/shipping/create

This endpoint renders a template with form for creating a new shipping address. route details

DELETE /tools/recurring/portal/<string:customer_hash>/shipping/<int:address_id>

This endpoint allows to delete an existing shipping address. Only available if no live subscription exists under this address.

Shipping Address object

Object contains the different variables of information you may want to access when rendering an object. Some objects will even contain child properties, such as shipping.subscription.address_id.

Property Definition
shipping.address1
string		 "shipping.address1": "101 Washington Street"
The street associated with the address.
shipping.address2
string		 "shipping.address2": "Suite 101"
Any additional information associated with the address.
shipping.cart_note
string		 "shipping.cart_note": ""
The note that that will be passed to the “note” field of orders made within the address.
shipping.city
string		 "shipping.city": "Los Angeles"
The city associated with the address.
shipping.company
string		 "shipping.company": "Recharge"
The company associated with the address.
shipping.country
string		 "shipping.country": "United States"
The country associated with the address.
shipping.created_at
string		 "shipping.created_at": "2018-02-21T11:46:01"
The date and time when the address was created.
shipping.customer_id
number		 "shipping.customer_id": 8187626
Unique numeric identifier for the customer associated with the address.
shipping.discount_id
number		 "shipping.discount_id": null
Unique numeric identifier for the discount.
shipping.first_name
string		 "shipping.first_name": "John"
The customer’s first name associated with the address.
shipping.id
number		 "shipping.id": 7976732
Unique numeric identifier for the address.
shipping.include
object		 "shipping.include": {"payment_methods": []}
Includes payment methods.
shipping.include.payment_methods
array		 "shipping.include.payment_methods": [{
"billing_address": {
"address1" : "220 Division Street South",
"address2" : "River Level",
"city" : "NORTHFIELD",
"company": null
"country": "United States",
"first_name": "Shiping",
"last_name": "Data4",
"phone": "",
"province": "Minnesota",
"zip": "55057"
},
"created_at": "2021-12-15T10:35:00",
"default": true,
"include": {},
"payment_details": {
"brand": "visa",
"exp_month": 11,
"exp_year": 2023,
"last4": 1111
},
"payment_type": "CREDIT_CARD",
"processor_customer_token": "cus_Fh9JvsIGSONGWn",
"processor_name": "stripe",
"processor_payment_method_token": "pm_1JUCFtJ2zqHvZRd15i1bCqce",
"status": null
"status_reason": null
"updated_at": "2021-12-15T10:55:00"
}]
Payment methods details.
shipping.last_name
string		 "shipping.last_name": "Doe"
The customer’s last name associated with the address.
shipping.note_attributes
string		 "shipping.note_attributes": []
Extra information that is added to the address. Each array entry must contain a hash with “name” and “value” keys.
shipping.phone
string		 "shipping.phone": "3103103101"
The phone number associated with the address.
shipping.province
string		 "shipping.province": "California"
The state or province associated with the address.
shipping.shipping_lines_override
string		 "shipping.shipping_lines_override": null
If shipping rates need to be overridden no matter what settings are in Shopify, then desired shipping rate values needs to be set in this parameter. If this parameter has value null, charge will pull shipping rates from Shopify.
shipping.subscriptions
array		 "shipping.subscriptions": [{
"address_id": 61539090,
"analytics_data": {
"utm_params":[]
},
"cancellation_reason": null,
"cancellation_reason_comments": null,
"cancelled_at": null,
"charge_delay" : null,
"charge_interval_frequency": "30"
"created_at": "2021-01-21T16:24:15,"
"customer_id": 1263344150,
"cutoff_day_of_month_before_and_after": null,
"cutoff_day_of_week_before_and_after": null,
"email": "john.doe@email.com",
"expire_after_specific_number_of_charges": null,
"first_charge_date": null,
"has_queued_charges": 1,
"id": 126344150,
"is_prepaid": false,
"is_skippable": true,
"is_swappable": true,
"locked_pending_charge_id": 0,
"max_retries_reached": 0,
"next_charge_scheduled_at": "2022-01-28T00:00:00",
"order_day_of_month": null,
"order_day_of_week": null,
"order_interval_frequency": "30",
"order_interval_unit": "day",
"price": 7.99,
"product_title": "Pure Pistachios Auto renew",
"properties": [],
"quantity": 1,
"recharge_product_id": 1428131,
"shopify_product_id": 4536616321104,
"shopify_variant_id": 32180428734544
"sku": "PURE",
"sku_override": false,
"status": "ACTIVE",
"updated_at": "2021-01-21T16:24:15",
"variant_title": ""
}]
Array of subscriptions under this address
shipping.updated_at
string		 "shipping.updated_at": "2019-04-22T09:35:39"
The date and time when the address was last updated.
shipping.zip
string		 "shipping.zip": "90025"
The zip or postal code associated with the address.

[GET] - List shipping

GET /request_objects

(async () => {
  let schema = '{ "addresses": [] }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
    try {
      const response = await axios(url);
      // Successful request made
      console.log(response.data);
    } catch (error) {
      // Request failed
      console.error(error);
    }
})();

let schema = '{ "addresses": [] }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "addresses": {}, "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "addresses":[
      {
         "address1":"101 Washington Street",
         "address2":"Suite 101",
         "city":"Los Angeles",
         "company":"",
         "country":"United States",
         "created_at":"2018-10-09T08:38:33",
         "customer_id":8187626,
         "first_name":"John",
         "id":18586680,
         "last_name":"Doe",
         "province":"California",
         "zip":"90025"
         "payment_method": {
            "id": 1234567,
            "billing_address":{
                "address1":"101 Washington Street",
                "address2":"",
                "city":"Los Angeles",
                "company":"Recharge",
                "country":"United States",
                "first_name":"John",
                "last_name":"Doe",
                "phone":"5551231234",
                "province":"California",
                "zip":"90024"
            },
            "created_at": "2021-11-14T09:00:01",
            "customer_id":8187626,
            "default": true,
            "payment_details" : [
                {
                    "brand" : "visa",
                    "exp_month" : 04
                    "exp_year" : 2025,
                    "last4": 1235
                }
            ],
            "payment_type": "credit_card",
            "processor_customer_token":"cus_AB3ebcBaL6pCx9",
            "processor_name":"stripe",
            "processor_payment_token":"pm_123123",
            "updated_at": "2021-12-14T09:00:01"
         },
         "subscriptions":[
            {
               "address_id":18586680,
               "analytics_data": {
                  "utm_params": []
               },
               "cancellation_reason":null,
               "cancellation_reason_comments":null,
               "cancelled_at":null,
               "charge_delay": null,
               "charge_interval_frequency":"20",
               "created_at":"2019-04-22T09:48:22",
               "customer_id":8187626,
               "cutoff_day_of_month_before_and_after": null,
               "cutoff_day_of_week_before_and_after": null,
               "email": "johndoe@gmail.com"
               "expire_after_specific_number_of_charges":null,
               "first_charge_date": "2020-01-15T00:00:00",
               "has_queued_charges":1,
               "id":42012593,
               "is_prepaid": false,
               "is_skippable": true,
               "is_swappable": true,
               "locked_pending_charge_id": 0,
               "max_retries_reached":0,
               "next_charge_scheduled_at":"2019-12-26T00:00:00",
               "order_day_of_month":null,
               "order_day_of_week":null,
               "order_interval_frequency":"20",
               "order_interval_unit":"day",
               "price":27.0,
               "product":{
                  "collection_id":199120,
                  "created_at":"2019-03-27T15:45:48",
                  "discount_amount":10.0,
                  "discount_type":"percentage",
                  "handle":"sleep-box",
                  "id":1175780,
                  "images":{
                     "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep-box_large.jpg",
                     "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep-box_medium.jpg",
                     "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep-box.jpg",
                     "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep-box_small.jpg"
                  },
                  "inventory_policy":{
                     "one_time":"1",
                     "subscription":"1"
                  },
                  "shopify_details":{
                     "body_html":"Catch some zzz's with the Bare Sleep Box. We'll send you a monthly gift box filled with Bare Sleep supplements, eye masks, essential oil pillow spray, cleansing face cream, and everything else you need for a good night's sleep.",
                     "created_at":"2018-02-16T08:59:02-05:00",
                     "handle":"sleep-box",
                     "image":{
                        "alt":null,
                        "created_at":"2018-02-16T08:59:04-05:00",
                        "height":1060,
                        "position":1,
                        "shopify_id":1555100041280,
                        "shopify_product_id":505978880064,
                        "shopify_variant_ids":[

                        ],
                        "src":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep-box.jpg?v=1518789544",
                        "updated_at":"2018-02-16T08:59:04-05:00",
                        "width":1060
                     },
                     "images":[
                        {
                           "alt":null,
                           "created_at":"2018-02-16T08:59:04-05:00",
                           "height":1060,
                           "position":1,
                           "shopify_id":1555100041280,
                           "shopify_product_id":505978880064,
                           "shopify_variant_ids":[

                           ],
                           "src":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep-box.jpg?v=1518789544",
                           "updated_at":"2018-02-16T08:59:04-05:00",
                           "width":1060
                        }
                     ],
                     "options":[
                        {
                           "name":"Title",
                           "position":1,
                           "shopify_id":651181981760,
                           "shopify_product_id":505978880064,
                           "values":[
                              "Default Title"
                           ]
                        }
                     ],
                     "product_type":"",
                     "published_at":"2018-02-16T08:48:22-05:00",
                     "shopify_id":505978880064,
                     "tags":"",
                     "title":"Sleep Box",
                     "updated_at":"2019-03-27T15:46:10-04:00",
                     "variants":[
                        {
                           "barcode":"",
                           "compare_at_price":null,
                           "created_at":"2018-02-16T08:59:02-05:00",
                           "fulfillment_service":"manual",
                           "grams":1814,
                           "inventory_management":null,
                           "inventory_policy":"deny",
                           "inventory_quantity":1,
                           "option1":"Default Title",
                           "option2":null,
                           "option3":null,
                           "position":1,
                           "presentment_prices":null,
                           "price":"30.00",
                           "requires_shipping":true,
                           "shopify_id":5423555936320,
                           "shopify_image_id":null,
                           "shopify_product_id":505978880064,
                           "sku":"222",
                           "taxable":true,
                           "title":"Default Title",
                           "updated_at":"2019-03-27T15:46:10-04:00",
                           "weight":4.0,
                           "weight_unit":"lb"
                        }
                     ],
                     "vendor":"bare-supplements"
                  },
                  "shopify_product_id":505978880064,
                  "subscription_defaults":{
                     "charge_interval_frequency":6,
                     "cutoff_day_of_month":null,
                     "cutoff_day_of_week":null,
                     "expire_after_specific_number_of_charges":null,
                     "modifiable_properties": [],
                     "number_charges_until_expiration":null,
                     "order_day_of_month":0,
                     "order_day_of_week":null,
                     "order_interval_frequency_options":[
                        "6"
                     ],
                     "order_interval_unit":"Months",
                     "storefront_purchase_options":"subscription_and_onetime"
                  },
                  "title":"Sleep Box",
                  "updated_at":"2019-03-27T15:46:10"
               },
               "product_title":"Sleep Box  10.00% Off Auto renew",
               "properties":[

               ],
               "quantity":1,
               "recharge_product_id":1175780,
               "shopify_product_id":505978880064,
               "shopify_variant_id":5423555936320,
               "sku":null,
               "sku_override":false,
               "status":"ACTIVE",
               "updated_at":"2019-04-22T09:55:18",
               "variant_title":"Sleep Box"
               },
               {
                  "address_id":7976732,
                  "analytics_data": {
                     "utm_params": []
                  },
                  "cancellation_reason":"I already have more than I need",
                  "cancellation_reason_comments":"Some comment here",
                  "cancelled_at":null,
                  "charge_delay": null,
                  "charge_interval_frequency":"1",
                  "created_at":"2019-04-03T09:20:28",
                  "customer_id":8187626,
                  "cutoff_day_of_month_before_and_after": null,
                  "cutoff_day_of_week_before_and_after": null,
                  "email": "johndoe@gmail.com"
                  "expire_after_specific_number_of_charges":null,
                  "first_charge_date": "2020-01-15T00:00:00",
                  "has_queued_charges":0,
                  "id":40628734,
                  "is_prepaid": false,
                  "is_skiipable": true,
                  "is_swappable": false,
                  "max_retries_reached":0,
                  "next_charge_scheduled_at":null,
                  "order_day_of_month":null,
                  "order_day_of_week":null,
                  "order_interval_frequency":"1",
                  "order_interval_unit":"month",
                  "price":11.4,
                  "product":{
                     "collection_id":106965,
                     "created_at":"2018-02-16T15:55:41",
                     "discount_amount":5.0,
                     "discount_type":"percentage",
                     "handle":"free-trial-bare-energy",
                     "id":660262,
                     "images":{
                        "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/energy_large.jpg",
                        "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/energy_medium.jpg",
                        "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/energy.jpg",
                        "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/energy_small.jpg"
                     },
                     "inventory_policy":{
                        "one_time":"1",
                        "subscription":"1"
                     },
                     "shopify_details":{
                        "body_html":"<meta charset=\"utf-8\">\n<p>Subscribe for 3 months and receive the first month free.<br><br>Packed with vitamins and roots, these gummy supplements will help you recharge and energize. One supplement per day will help your mind and body stay alert and read to conquer the world.\u00a0</p>\n<p>Ingredients:</p>\n<ul>\n<li>Calcium</li>\n<li>B12</li>\n<li>Guarana</li>\n</ul>",
                        "created_at":"2018-02-16T15:54:53-05:00",
                        "handle":"free-trial-bare-energy",
                        "image":{
                           "alt":null,
                           "created_at":"2018-02-16T15:54:55-05:00",
                           "height":1060,
                           "position":1,
                           "shopify_id":1556209008704,
                           "shopify_product_id":506206715968,
                           "shopify_variant_ids":[

                           ],
                           "src":"https://cdn.shopify.com/s/files/1/3104/4618/products/energy.jpg?v=1518814495",
                           "updated_at":"2018-02-16T15:54:55-05:00",
                           "width":1060
                        },
                        "images":[
                           {
                              "alt":null,
                              "created_at":"2018-02-16T15:54:55-05:00",
                              "height":1060,
                              "position":1,
                              "shopify_id":1556209008704,
                              "shopify_product_id":506206715968,
                              "shopify_variant_ids":[

                              ],
                              "src":"https://cdn.shopify.com/s/files/1/3104/4618/products/energy.jpg?v=1518814495",
                              "updated_at":"2018-02-16T15:54:55-05:00",
                              "width":1060
                           }
                        ],
                        "options":[
                           {
                              "name":"Title",
                              "position":1,
                              "shopify_id":651454382144,
                              "shopify_product_id":506206715968,
                              "values":[
                                 "Default Title"
                              ]
                           }
                        ],
                        "product_type":"",
                        "published_at":"2018-02-16T15:54:24-05:00",
                        "shopify_id":506206715968,
                        "tags":"",
                        "title":"Free Trial - Bare Energy 3 Month Subscription",
                        "updated_at":"2019-03-27T15:30:21-04:00",
                        "variants":[
                           {
                              "barcode":"",
                              "compare_at_price":null,
                              "created_at":"2018-02-16T15:54:53-05:00",
                              "fulfillment_service":"manual",
                              "grams":907,
                              "inventory_management":null,
                              "inventory_policy":"deny",
                              "inventory_quantity":-3,
                              "option1":"Default Title",
                              "option2":null,
                              "option3":null,
                              "position":1,
                              "presentment_prices":null,
                              "price":"12.00",
                              "requires_shipping":true,
                              "shopify_id":5424766091328,
                              "shopify_image_id":null,
                              "shopify_product_id":506206715968,
                              "sku":"",
                              "taxable":true,
                              "title":"Default Title",
                              "updated_at":"2019-05-05T03:42:55-04:00",
                              "weight":32.0,
                              "weight_unit":"oz"
                           }
                        ],
                        "vendor":"bare-supplements"
                     },
                     "shopify_product_id":506206715968,
                     "subscription_defaults":{
                        "charge_interval_frequency":2,
                        "cutoff_day_of_month":null,
                        "cutoff_day_of_week":null,
                        "expire_after_specific_number_of_charges":null,
                        "number_charges_until_expiration":null,
                        "order_day_of_month":null,
                        "order_day_of_week":null,
                        "order_interval_frequency_options":[
                           "2",
                           "1"
                        ],
                        "order_interval_unit":"Weeks",
                        "storefront_purchase_options":"subscription_and_onetime"
                     },
                     "title":"Free Trial - Bare Energy",
                     "updated_at":"2019-03-13T09:47:37"
                  },
                  "product_title":"Free Trial - Bare Energy  Auto renew",
                  "properties":[

                  ],
                  "quantity":1,
                  "recharge_product_id":660262,
                  "shopify_product_id":506206715968,
                  "shopify_variant_id":5424766091328,
                  "sku":null,
                  "sku_override":false,
                  "status":"CANCELLED",
                  "updated_at":"2019-04-22T09:35:44",
                  "variant_title":""
               },
               ...
         ]
      },
      {
         "address1":"987 Bluebird Street",
         "address2":"APT 9",
         "cart_note":"",
         "city":"Los Angeles",
         "company":"Recharge",
         "country":"United States",
         "created_at":"2018-02-21T11:46:01",
         "customer_id":8187626,
         "discount": {},
         "discount_id":null,
         "first_name":"John",
         "id":7976732,
         "include": {
            "payment_methods": []
         },
         "last_name":"Doe",
         "note_attributes":[],
         "phone":"5551231234",
         "province":"California",
         "shipping_lines_override":null,
         "subscriptions" : [],
         "updated_at":"2019-04-22T09:35:39",
         "zip":"90025"
      }
   ],
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"johndoe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-04-30T15:11:43"
   },
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a list of addresses for customer.

URL: {{ shipping_list_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/shipping?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/shipping?token=${window.customerToken}

Template file: shipping.html

Schema: '{ "addresses": {}, "customer": {}, "settings": {}, "store": {} }'

Available template objects:

[POST] - Create new shipping address

POST /shipping/create

(async () => {
  let url = '{{ address_list_url }}' + '?token=' + window.customerToken;
  let data = {
    "address1":"101 Washington Street",
    "address2":"Suite 101",
    "city":"Los Angeles",
    "company":"Bootstrap",
    "country":"United States",
    "first_name":"John",
    "last_name":"Doe",
    "phone":"5551231234",
    "province":"California",
    "zip":"90025"
   }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ address_list_url }}';
let data = {
  "address1":"101 Washington Street",
  "address2":"Suite 101",
  "city":"Los Angeles",
  "company":"Bootstrap",
  "country":"United States",
  "first_name":"John",
  "last_name":"Doe",
  "phone":"5551231234",
  "province":"California",
  "zip":"90025"
}
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ address_list_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    "address1":"101 Washington Street",
    "address2":"Suite 101",
    "city":"Los Angeles",
    "company":"Bootstrap",
    "country":"United States",
    "first_name":"John",
    "last_name":"Doe",
    "phone":"5551231234",
    "province":"California",
    "zip":"90025"
   }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"Suite 101",
      "cart_attributes":null,
      "cart_note":null,
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "phone":"5551231234",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-04-30T15:25:20",
      "zip":"90025"
   }
}

This endpoint creates a new address for customer.

URL: {{ shipping_create_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/shipping/create?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/shipping/create?token=${window.customerToken}

Template file: create_shipping.html

Available template objects:

Arguments accepted:

Property Type
first_name * string
last_name * string
company string
address1 * string
address2 string
city * string
country * string
province * string
zip * string
phone string

* = required

[GET] - Retrieve a shipping address

GET /request_objects

(async () => {
  let schema = '{ "addresses": { "id": <int:address_id> }, "shipping_countries": [], "customer": {}, "settings": {},
    "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "addresses": { "id": <int:address_id> }, "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "addresses": { "id": <int:address_id> }, "shipping_countries": [], "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "addresses":{
      "address1":"101 Washington Street",
      "address2":"Suite 101",
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "phone":"5551231234",
      "province":"California",
      "updated_at":"2019-04-30T15:25:20",
      "zip":"90025"
   },
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"johndoe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-04-30T15:11:43"
   },
   "shipping_countries":[
      {
         "code":"CA",
         "country_id":37,
         "id":null,
         "name":"Canada",
         "provinces":[
            {
               "code":"PE",
               "id":1940,
               "name":"Prince Edward Island"
            },
            {
               "code":"BC",
               "id":1941,
               "name":"British Columbia"
            },
            ...
         ]
      },
      {
         "code":"LY",
         "country_id":123,
         "id":null,
         "name":"Libyan Arab Jamahiriya",
         "provinces":[

         ]
      },
      ...
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

SHELL CODE HERE

This endpoint renders a template with form for updating customer's address.

URL: {{ shipping_address_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/shipping/<int:address_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/shipping/<int:address_id>?token=${window.customerToken}

Template file: edit_shipping_address.html

Available template objects:

[GET] - Update payment method on a shipping address

GET /shipping/<int:address_id>/payment_method

(async () => {
  let schema = '{ "addresses": { "id": <int:address_id> }, "payment_methods": [], "billing_countries": [], "customer": {}, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "addresses": { "id": <int:address_id> }, "payment_methods": [], "billing_countries": [], "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "addresses": { "id": <int:address_id> }, "payment_methods": [], "billing_countries": [], "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"204",
      "cart_attributes":null,
      "cart_note":"Updated phone",
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2019-04-30T15:25:20",
      "customer_id":8187626,
      "discount_id":null,
      "first_name":"John",
      "id":32172754,
      "last_name":"Doe",
      "note_attributes":null,
      "original_shipping_lines":null,
      "phone":"5551231234",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-05-02T14:07:16",
      "zip":"90025"
   }
}

This endpoint updates an existing address for customer.

URL: {{shipping_payment_method_url}}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/shipping/<int:address_id>/payment_method?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/shipping/<int:address_id>/payment_method?token=${window.customerToken}

Template file: edit_shipping_payment_method.html

Available template objects:

Shipping Country object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
shipping_country.code
string		 "shipping_country.code": "AU"
The code of the shipping country.
shipping_country.country_id
number		 "shipping_country.country_id": 12
Id of the shipping country.
shipping_country.id
string		 "shipping_country.id": "null"
Id of the shipping country.
shipping_country.name
string		 "shipping_country.name": "Australia"
Name of the shipping country.
shipping_country.provinces
array of objects		 "shipping_country.provinces": [
"code": "ACT",
"id": 2289,
"name": "Australian Capital Territory"
]

Country provinces.

Charge

A charge is a placeholder for an upcoming charge once the charge is processed successfully. The corresponding order or orders in the case of prepaid will be created and the 1st order will be submitted to shopify.

Charge routes

Routes are used to retrieve, create, or modify existing data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


GET /tools/recurring/portal/<string:customer_hash>/request_objects
This endpoint retrieves a list of charges for customer. route details

POST /tools/recurring/portal/<string:customer_hash>/charges/<int:charge_id>/process
This enpoint updates/processes an existing charge for customer. route details

POST /tools/recurring/portal/<string:customer_hash>/charges/<int:charge_id>/skip
This endpoint skips one or more subscriptions attached to a single queued charge. route details

POST /tools/recurring/portal/<string:customer_hash>/charges/<int:charge_id>/unskip
This endpoint unskips one or more subscriptions attached to a single queued charge. route details

Charge object


Property Definition
charge.address_id
number		 "charge.address_id": 32172754
The id of the customer shipping address that this order is tied to.
charge.analytics_data.utm_params
array		 "charge.analytics_data.utm_params": []
charge.billing_address "address1": "101 Washington Street"
"address2": "204"
"city": "Los Angeles"
"company": "Recharge"
"country": "United States"
"first_name": "John"
"last_name": "Doe"
"phone": 5551231234
"province": "California"
"zip": 90025

This is all of the billing information related to the order:
  • [string] address1: The street address of the billing address.
  • [string] address2: An optional additional field for the street address of the billing address.
  • [string] city: The city of the billing address.
  • [string] company: The company of the person associated with the billing address.
  • [string] country: The name of the country of the billing address.
  • [string] first_name: The first name of the person associated with the payment method.
  • [string] last_name: The last name of the person associated with the payment method.
  • [string] phone: The phone number associated with the billing address.
  • [string] province: The name of the state or province of the billing address.
  • [string] zip:The zip or postal code of the billing address.
charge.client_details "browser_ip": null
"user_agent": null
The client details, this attribute can be used to see from which device subscription is created.
charge.created_at
string		 "charge.created_at": "2019-05-06T15:08:49"
The date and time when the charge was created.
charge.currency
string		 "charge.currency": "USD"
The code of the currency for this Charge, such as USD.
charge.customer_hash
string		 "charge.customer_hash": "818762670d14f56b6f39fd7"
The unique string identifier used in a customers portal link.
charge.customer_id
number		 "charge.customer_id": 8187626
Shopify's unique identifier for the customer.
charge.discount_codes
array		 "amount: 184.23
"code": "DISCOUNT_CODE"
"recharge_discount_id": 85855220
"type": "fixed_amount"
The discount codes from store settings.
charge.email
string		 "charge.email": "John@test.com"
The email address of the customer.
charge.error
string		 "charge.error": "no Variant found on shopify"
Error message of the charge.
charge.error_type
string		 "charge.error_type": "VARIANT_DOES_NOT_EXIST"
Error type of charge.
charge.first_name
string		 "charge.first_name": "John"
The first name of the customer.
charge.has_uncommited_changes
boolean		 "charge.has_uncommited_changes": false
Specifies whether the charge is scheduled for a regeneration (if the subscription related to the charge was updated in the last 5-30s with “commit_update”:false)
charge.id
number		 "charge.id": 158825571
The unique numeric identifier for the charge.
charge.include
object		 "order_modifications": [{
"charge_id": 479471048,
"created_at": "2022-11-30T10:46:56",
"id": 151,
"modifications": {
"line_items": [{
"line_item_id": 1,
"modification_type": "delete",
"modifications": [{
"attribute": "quantity",
"created_at": "2022-11-30T10:45:08",
"previous_value": "2",
"reason": "Removed due to inventory",
"value": null
}],
"subscription_id": 203309206
},
{
"line_item_id": 2,
"modification_type": "update",
"modifications": [{
"attribute": "quantity",
"created_at": "2022-11-30T10:45:09",
"previous_value": "3",
"reason": "Quantity reduced due to inventory",
"value": "2"
}],
"subscription_id": 203309207
}]
},
"order_id": 310319778,
"updated_at": "2022-11-30T10:47:07"
}]
Object that contains information about order modifications:
  • [array] order_modifications: Array of objects containing orders that have been modified.
  • [number] charge_id: Id of the modified charge.
  • [string] created_at: Date when the order was modified.
  • [number] id: Id of the modification object.
  • [object] modifications: Object containing modified line items.
  • [array] line_items: Array of objects containing modifitations of line items.
  • [number] line_item_id: Id of modified line item.
  • [string] modification_type: Type of modification which can be either "Delete" or "Update".
  • [array] modifications: Array of objects containing information about the modifications done to the line item.
  • [string] attribute: Which attribute has been updated.
  • [string] created_at: Date when the line item was modified.
  • [string] previous_value: Previous value that has been modified.
  • [string] reason: Reason for the modification.
  • [string] value: New value after modification.
  • [number]subscription_id: Id of the subscription that was modified.
  • [number] order_id: Id of the order that was moidified.
  • [string] updated_at: Date when the order was modified.
charge.last_charge_attempt_date
string		 "charge.last_charge_attempt_date": "2020-03-02T15:29:56"
Date of the last cherge attempt for charge with stauts: "ERROR".
charge.last_name
string		 "charge.last_name": "Doe"
The last name of the customer.
charge.line_items
array		 "grams": 1814
"images": {}
"price": "70.00"
"properties": []
"quantity": 1
"shopify_product_id": "506020921408"
"shopify_variant_id": "5424189177920"
"sku": ""
"subscription_id": 42603951
"tax_lines": []
"type": "SUBSCRIPTION"
"title": "Bare Box - 3 Month Plan"
"variant_title": "x-small"
"vendor": "recharge-test-store"

A list of line item objects, each one containing information about an item in the charge:
  • [number] grams: The grams of the product.
  • [object] images: The images of the product.
  • [string] price: The price of the product.
  • [array] properties: The properties of the product.
  • [number] quantity: The quantity of the product.
  • [string] shopify_product_id: The id of the Shopify product.
  • [number] shopify_variant_id: The id of the Shopify product variant.
  • [string] sku: The sku of the Shopify product.
  • [array] tax_lines: Tax lines array
  • [number] subscription_id: The unique numeric identifier for a subscription.
  • [string] title: The title of the product.
  • [string] type: The type of the charge.
  • [string] variant_title: The title of the product variant.
  • [string] vendor: The name of the vendor.
charge.note
string		 "charge.note": "Updated phone"
Note attribute used to store custom notes.
charge.note_attributes
array		 "charge.note_attributes": null
Custom key value pairs can be stored here.
charge.number_times_tried
number		 "charge.number_times_tried": 6
Number of times charge processing was attempted.
charge.processed_at
string		 "charge.processed_at": "2020-03-08T00:00:00"
The date and time when the charge is processed.
charge.processor_name
string		 "charge.processor_name": "stripe"
It identifies payment processor. It could have stripe, braintree or authorize value.
charge.requires_shipping
boolean		 "charge.requires_shipping": true
Whether or not a charge requires shipping.
charge.retry_date
string		 "charge.retry_date": "2020-03-08T00:00:00"
Next charge attempt date for charge with status "ERROR".
charge.scheduled_at
string		 "charge.scheduled_at": "2019-07-07T00:00:00"
The date and time when the charge is scheduled.
charge.shipments_count
number		 "charge.shipments_count": 10
A number of successfully sent orders for the specific charge.
charge.shipping_address "address1": "101 Washington Street"
"address2": "204"
"city": "Los Angeles"
"company": "Recharge"
"country": "United States"
"first_name": "John"
"last_name": "Doe"
"phone": 5551231234
"province": "California"
"zip": 90025

The mailing address where the order will be shipped to:
  • [string] address1: The street address of the shipping address.
  • [string] address2: An optional additional field for the street address of the shipping address.
  • [string] city: The city of the shipping address.
  • [string] company: The company of the person associated with the shipping address.
  • [string] country: The name of the country of the shipping address.
  • [string] first_name: The first name of the person associated with the shipping address.
  • [string] last_name: The last name of the person associated with the shipping address.
  • [string] phone: The phone number associated with the shipping address.
  • [string] province: The name of the state or province of the shipping address.
  • [number] zip: The zip or postal code of the shipping address.
charge.shipping_lines
array		 "code": "Priority"
"description": null
"price": "7.81"
"source": "Subscription"
"tax_lines": "[]"
"title": "Priority Mail"

The shipping lines:
  • [string] code: The code of shipping lines.
  • [string] description: The description of shipping lines.
  • [string] price: The price of shipping lines.
  • [string] source: The source of shipping lines.
  • [array] tax_lines: Tax lines array.
  • [string] title: The title of shipping lines.
charge.shopify_order_id
string		 "charge.shopify_order_id": null
The unique numeric identifier within Shopify for the charge.
charge.shopify_variant_id_not_found
"charge.shopify_variant_id_not_found": null
charge.status
string		 "charge.status": "SUCCESS", "QUEUED", "ERROR", "SKIPPED"
The status of creating the charge within Shopify.
charge.subtotal_price
string		 "charge.subtotal_price": "70.0"
The item price without taxes and discounts.
charge.tags
string		 "charge.tags": "Subscription, Subscription Recurring Order"
The custom tags for the charge.
charge.tax_lines
number		 "charge.tax_lines": 0
The tax lines for the charge.
charge.total_discounts
string		 "charge.total_discounts": "0.0"
The sum of the discounts applied to the product.
charge.total_duties
number		 "charge.total_duties": null
The sum of all duties applied to the line items in the order in the currency's subunit.
charge.total_line_items_price
string		 "charge.total_line_items_price": "70.00"
The total price of line items.
charge.total_price
string		 "charge.total_price": "77.81"
The sum of all the prices of all the items in the charge, taxes and discounts included (must be positive).
charge.total_refunds
string		 "charge.total_refunds": null
The sum of all refunds that were made on specific charge.
charge.total_tax
number		 "charge.total_tax": 0
The total tax of an order.
charge.total_weight
number		 "charge.total_weight": 1814
Total weight of the product.
charge.transaction_id
string		 "charge.transaction_id": null
The unique alphanumeric identifier of the transaction.
charge.type
string		 "charge.type": "RECURRING"
Shows if order was made from checkout or a recurring charge. Inputs: “CHECKOUT” or “RECURRING”.
charge.updated_at
string		 "charge.updated_at": "2019-05-14T12:32:24"
The date and time when the charge was updated.

[GET] - List of charges

GET /request_objects

(async () => {
  let schema = '{ "charges": [] }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "charges": [] }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}`,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "charges": [] }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE


{
"charges":

    [
        "address_id": 18586680,
        "analytics_data": {
            "utm_params": []
        },
        "billing_address": {
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "122211121212",
            "province": "",
            "zip": "11070"
        },
        "client_details": {
            "browser_ip": null,
            "user_agent": null,
        },
        "created_at": "2020-02-05T08:45:41",
        "currency": "USD",
        "customer_hash": "818762670d14f56b6f39fd7",
        "customer_id": 8187626,
        "discount_codes": [],
        "email": "john.doe@test.com",
        "first_name": "John",
        "has_uncommited_changes": false,
        "id": 32172457,
        "include": {
          "order_modifications": [{
          "charge_id": 479471048,
          "created_at": "2022-11-30T10:46:56",
          "id": 151,
          "modifications": {
            "line_items": [{
              "line_item_id": 1,
              "modification_type": "delete",
              "modifications": [{
                "attribute": "quantity",
                "created_at": "2022-11-30T10:45:08",
                "previous_value": "2",
                "reason": "Removed due to inventory",
                "value": null
              }],
              "subscription_id": 203309206
            },
            {
              "line_item_id": 2,
              "modification_type": "update",
              "modifications": [{
                "attribute": "quantity",
                "created_at": "2022-11-30T10:45:09",
                "previous_value": "3",
                "reason": "Quantity reduced due to inventory",
                "value": "2"
                }],
                "subscription_id": 203309207
            }]
          },
          "order_id": 310319778,
          "updated_at": "2022-11-30T10:47:07"
          }]
        },
        "last_name": "Doe",
        "line_items": [
            {
            "grams": 0,  
            "images": {
                "large": "",
                "medium": "",
                "original": "",
                "small": ""
                },
            "original_price": "100.00",    
            "price": "100.00",
            "properties": [],
            "quantity": 3,
            "shopify_product_id": "4441899073674",
            "shopify_variant_id": "31666207588490",
            "sku": "",
            "subscription_id": 6187834,
            "tax_lines": [],
            "title": "Optimum Nutrition Gold Standard Whey Auto renew",
            "type": "SUBSCRIPTION",
            "variant_title": "",
            "vendor": "recharge-test-store"
            }
        ],
        "note": "next order in sequence 1",
        "note_attributes": [],
        "processed_at": "2020-02-05T08:55:39",
        "processor_name": "stripe",
        "requires_shipping": true,
        "scheduled_at": "2020-02-05T00:00:00",
        "shipments_count": 1,
        "shipping_address": {
            "address1": "Bulevar Mihajla Pupina 10",
            "address2": "",
            "city": "Belgrade",
            "company": "BG",
            "country": "Serbia",
            "first_name": "Uros",
            "last_name": "Bijelic",
            "phone": "122211121212",
            "province": "",
            "zip": "11070",
        },
        "shipping_lines": {
            "code": "Standard",
            "description": null,
            "price": "0.00",
            "source": "Subscription",
            "tax_lines": [],
            "title": "Standard",
        },
        "shopify_order_id": "197852934323",
        "status": "SUCCESS",
        "subtotal_price": "300.0",
        "tags": "Subscription, Subscription Recurring Order",
        "tax_lines": 0,
        "total_discounts": "0.0",
        "total_duties": null,
        "total_line_items_price": "300.00",
        "total_price": "300.00",
        "total_refunds": null,
        "total_tax": 0,
        "total_weight": 2724,
        "transaction_id": "ch_1G8oLuJ2zqasdfd1owLGogae",
        "type": "RECURRING",
        "updated_at": "2020-02-05T09:55:41",
    ],
    [
        "address_id": 18586680,
        "analytics_data": "{utm_params: []}",
        "billing_address": {
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "122211121212",
            "province": "",
            "zip": "11070"
        },
        "client_details": {
            "browser_ip": null,
            "user_agent": null,
        },
        "created_at": "2020-02-05T08:45:41",
        "currency": "USD",
        "customer_hash": "818762670d14f56b6f39fd7",
        "customer_id": 8187626,
        "discount_codes": [],
        "email": "john.doe@test.com",
        "first_name": "John",
        "has_uncommited_changes": false,
        "id": 32172457,
        "include": {
          "order_modifications": []
        },
        "last_name": "Doe",
        "line_items": [
            {
            "grams": 0,
            "images": { 
                "large": "",
                "medium": "",
                "original": "",
                "small": ""
                },
            "original_price": "100.00",    
            "price": "100.00",
            "properties": [],
            "quantity": 3,
            "shopify_product_id": "4441899073674",
            "shopify_variant_id": "31666207588490",
            "sku": "",
            "subscription_id": 6187834,
            "tax_lines": [],
            "title": "Optimum Nutrition Gold Standard Whey Auto renew",
            "type": "SUBSCRIPTION",
            "variant_title": "",
            "vendor": "recharge-test-store"
            }
        ],
        "note": "next order in sequence 1",
        "note_attributes": [],
        "processor_name": "stripe",
        "requires_shipping": true,
        "scheduled_at": "2020-02-05T00:00:00",
        "shipments_count": null,
        "shipping_address": {
            "address1": "Bulevar Mihajla Pupina 10",
            "address2": "",
            "city": "Belgrade",
            "company": "BG",
            "country": "Serbia",
            "first_name": "Uros",
            "last_name": "Bijelic",
            "phone": "122211121212",
            "province": "",
            "zip": "11070",
        },
        "shipping_lines": {
            "code": "Standard",
            "description": null,
            "price": "0.00",
            "source": "Subscription",
            "tax_lines": [],
            "title": "Standard",
        },
        "shopify_order_id": "null",
        "status": "QUEUED",
        "subtotal_price": "300.0",
        "tags": "Subscription, Subscription Recurring Order",
        "tax_lines": 0,
        "total_discounts": "0.0",
        "total_duties": null,
        "total_line_items_price": "300.00",
        "total_price": "300.00",
        "total_refunds": null,
        "total_tax": 0,
        "total_weight": 2724,
        "transaction_id": null,
        "type": "RECURRING",
        "updated_at": "2020-02-05T09:55:41"

    ],
    [
        "address_id": 18586680,
        "analytics_data": {utm_params: []},
        "billing_address": {
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "122211121212",
            "province": "",
            "zip": "11070"
        },
        "client_details": {
            "browser_ip": null,
            "user_agent": null,
        },
        "created_at": "2020-02-05T08:45:41",
        "currency": "USD",
        "customer_hash": "818762670d14f56b6f39fd7",
        "customer_id": 8187626,
        "discount_codes": [],
        "email": "john.doe@test.com",
        "error": "Request req_VwzvfensElCeD: Your card was declined. decline_code = generic_decline",
        "error_type": "CLOSED_MAX_RETRIES_REACHED",
        "first_name": "John",
        "has_uncommited_changes": false,
        "id": 32172457,
        "include": {
          "order_modifications": []
        },
        "last_charge_attempt_date": "2020-03-02T15:29:59",
        "last_name": "Doe",
        "line_items": [
            {
            "grams": 0,
            "images": { 
                "large": "",
                "medium": "",
                "original": "",
                "small": ""
                },
            "original_price": "100.00",
            "price": "100.00",
            "properties": [],
            "quantity": 3,
            "shopify_product_id": "4441899073674",
            "shopify_variant_id": "31666207588490",
            "sku": "",
            "subscription_id": 6187834,
            "tax_lines": [],
            "title": "Optimum Nutrition Gold Standard Whey Auto renew",
            "type": "SUBSCRIPTION",
            "variant_title": "",
            "vendor": "recharge-test-store"
            }
        ],
        "note": "next order in sequence 1",
        "note_attributes": [],
        "number_times_tried": 6,
        "processor_name": "stripe",
        "requires_shipping": true,
        "retry_date": "2020-03-08T00:00:00",
        "scheduled_at": "2020-02-06T00:00:00",
        "shipments_count": null,
        "shipping_address": {
            "address1": "Bulevar Mihajla Pupina 10",
            "address2": "",
            "city": "Belgrade",
            "company": "BG",
            "country": "Serbia",
            "first_name": "Uros",
            "last_name": "Bijelic",
            "phone": "122211121212",
            "province": "",
            "zip": "11070",
        },
        "shipping_lines": {
            "code": "Standard",
            "description": null,
            "price": "0.00",
            "source": "Subscription",
            "tax_lines": [],
            "title": "Standard"
        },
        "shopify_order_id": null,
        "shopify_variant_id_not_found": null,
        "status": "ERROR",
        "subtotal_price": "300.0",
        "tags": "Subscription, Subscription Recurring Order",
        "tax_lines": 0,
        "total_discounts": "0.0",
        "total_duties": null,
        "total_line_items_price": "300.00",
        "total_price": "300.00",
        "total_refunds": null,
        "total_tax": 0,
        "total_weight": 2724,
        "transaction_id": null,
        "type": "RECURRING",
        "updated_at": "2020-02-05T09:55:41",
    ]

}

List all charges for the current customer.

Methods accepted: GET

Schema: '{ "charges": [] }'

Embedded Route: /tools/recurring/portal/<string:customer_hash>/request_objects?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/request_objects?token=${window.customerToken}

[POST] - Process a charge

POST /charges/<int:charge_id>/process

(async () => {
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/process?token=${window.customerToken}`;

  try {
    const response = await axios.post(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/process?token=${window.customerToken}`;
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  }
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/process?token=${window.customerToken}`,
  type: 'post',
  }).done(function(response) {
    // Successful request made
    console.log(response);
  }).fail(function(response) {
    // Request failed
    console.log(response);
  });

CLICK HERE TO SEE RESPONSE


{
"charges":

    [
        "address_id": 18586680,
        "analytics_data": {
            "utm_params": []
        },
        "billing_address": {
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "122211121212",
            "province": "",
            "zip": "11070"
        },
        "client_details": {
            "browser_ip": null,
            "user_agent": null,
        },
        "created_at": "2020-02-05T08:45:41",
        "currency": "USD",
        "customer_hash": "818762670d14f56b6f39fd7",
        "customer_id": 8187626,
        "discount_codes": [],
        "email": "john.doe@test.com",
        "first_name": "John",
        "has_uncommited_changes": false,
        "id": 32172457,
        "last_name": "Doe",
        "line_items": [
            {
            "grams": 0,
            "images": {
                "large": "",
                "medium": "",
                "original": "",
                "small": ""
                },
            "original_price": "100.00",
            "price": "100.00",
            "properties": [],
            "quantity": 3,
            "shopify_product_id": "4441899073674",
            "shopify_variant_id": "31666207588490",
            "sku": "",
            "subscription_id": 6187834,
            "tax_lines": [],
            "title": "Optimum Nutrition Gold Standard Whey Auto renew",
            "type": "SUBSCRIPTION",
            "variant_title": "",
            "vendor": "recharge-test-store"
            }
        ],
        "note": "next order in sequence 1",
        "note_attributes": [],
        "processed_at": "2020-02-05T08:55:39",
        "processor_name": "stripe",
        "requires_shipping": true,
        "scheduled_at": "2020-02-05T00:00:00",
        "shipments_count": 1,
        "shipping_address": {
            "address1": "Bulevar Mihajla Pupina 10",
            "address2": "",
            "city": "Belgrade",
            "company": "BG",
            "country": "Serbia",
            "first_name": "Uros",
            "last_name": "Bijelic",
            "phone": "122211121212",
            "province": "",
            "zip": "11070",
        },
        "shipping_lines": {
            "code": "Standard",
            "description": null,
            "price": "0.00",
            "source": "Subscription",
            "tax_lines": [], 
            "title": "Standard"
        },
        "shopify_order_id": "197852934323",
        "status": "SUCCESS",
        "sub_total": null,
        "subtotal_price": "300.0",
        "tags": "Subscription, Subscription Recurring Order",
        "tax_lines": 0,
        "total_discounts": "0.0",
        "total_duties": null,
        "total_line_items_price": "300.00",
        "total_price": "300.00",
        "total_refunds": null,
        "total_tax": 0,
        "total_weight": 2724,
        "transaction_id": "ch_1G8oLuJ2zqasdfd1owLGogae",
        "type": "RECURRING",
        "updated_at": "2020-02-05T09:55:41",
    ],
}

The charge processing route can be used to process charges that are in queued status. Processing a queued charge can be accomplished by a POST request to the charge processing endpoint with the respective charge_id.

Methods accepted: POST

Embedded Route: /tools/recurring/portal/{{ customer.hash }}/charges/<int:charge_id>/process?token=${window.customerToken}

Hosted Route: /portal/{{ customer.hash }}/charges/<int:charge_id>/process?token=${window.customerToken}

[POST] - Skip subscriptions

POST /charges/<int:charge_id>/skip

(async () => {
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/skip?token=${window.customerToken}`;

  let data = {
    "subscription_ids": [1234567834, 4567893423]
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/skip?token=${window.customerToken}`;

let data = {
  "subscription_ids": [1234567834, 4567893423]
}

let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/skip?token=${window.customerToken}`,
  type: 'post',
  dataType: 'json',
  data: {
    "subscription_ids": [1234567834, 4567893423]
  },
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
"charge":
    {
        "address_id": 18586680,
        "analytics_data": {
            "utm_params": []
        },
        "billing_address": {
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "122211121212",
            "province": "",
            "zip": "11070"
        },
        "client_details": {
            "browser_ip": null,
            "user_agent": null
        },
        "created_at": "2020-02-05T08:45:41",
        "customer_hash": "818762670d14f56b6f39fd7",
        "customer_id": 8187626,
        "discount_codes": [],
        "email": "john.doe@test.com",
        "first_name": "John",
        "has_uncommited_changes": false,
        "id": 32172457,
        "last_name": "Doe",
        "line_items": [
            "grams": 0,
            {
            "images": {
                "large": "",
                "medium": "",
                "original": "",
                "small": ""
                },
            "original_price": "100.00",
            "price": "100.00",
            "properties": [],
            "quantity": 3,
            "shopify_product_id": "4441899073674",
            "shopify_variant_id": "31666207588490",
            "sku": "",
            "subscription_id": 6187834,
            "tax_lines": [],
            "title": "Optimum Nutrition Gold Standard Whey Auto renew",
            "type": "SUBSCRIPTION",
            "variant_title": "",
            "vendor": "recharge-test-store"
            }
        ],
        "note": "next order in sequence 1",
        "note_attributes": [],
        "processed_at": "2020-02-05T08:55:39",
        "processor_name": "stripe",
        "requires_shipping": true,
        "scheduled_at": "2020-02-05T00:00:00",
        "shipments_count": 1,
        "shipping_address": {
            "address1": "Bulevar Mihajla Pupina 10",
            "address2": "",
            "city": "Belgrade",
            "company": "BG",
            "country": "Serbia",
            "first_name": "Uros",
            "last_name": "Bijelic",
            "phone": "122211121212",
            "province": "",
            "zip": "11070",
        },
        "shipping_lines": {
            "code": "Standard",
            "description": null,
            "price": "0.00",
            "source": "Subscription",
            "tax_lines": [],
            "title": "Standard"
        },
        "shopify_order_id": "197852934323",
        "status": "SKIPPED",
        "sub_total": null,
        "subtotal_price": "300.0",
        "tags": "Subscription, Subscription Recurring Order",
        "tax_lines": 0,
        "total_discounts": "0.0",
        "total_duties": null,
        "total_line_items_price": "300.00",
        "total_price": "300.00",
        "total_refunds": null,
        "total_tax": 0,
        "total_weight": 2724,
        "transaction_id": "ch_1G8oLuJ2zqasdfd1owLGogae",
        "type": "RECURRING",
        "updated_at": "2020-02-05T09:55:41"
    }
}

This endpoint skips one or more subscriptions attached to a single queued charge. Must pass a list of subscription_ids to skip.

Methods accepted: POST

Embedded Route: /tools/recurring/portal/{{ customer.hash }}/charges/<int:charge_id>/skip?token=${window.customerToken}

Hosted Route: /portal/{{ customer.hash }}/charges/<int:charge_id>/skip?token=${window.customerToken}

[POST] - Unskip subscriptions

POST /charges/<int:charge_id>/unskip

(async () => {
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/unskip?token=${window.customerToken}`;

  let data = {
    "subscription_ids": [1234567834, 4567893423]
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/unskip?token=${window.customerToken}`;

let data = {
  "subscription_ids": [1234567834, 4567893423]
}

let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/charges/<int:charge_id>/unskip?token=${window.customerToken}`,
  type: 'post',
  dataType: 'json',
  data: {
    "subscription_ids": [1234567834, 4567893423]
  },
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
"charge":
    {
        "address_id": 18586680,
        "analytics_data": {
            "utm_params": []
        },
        "billing_address": {
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "122211121212",
            "province": "",
            "zip": "11070"
        },
        "client_details": {
            "browser_ip": null,
            "user_agent": null
        },
        "created_at": "2020-02-05T08:45:41",
        "customer_hash": "818762670d14f56b6f39fd7",
        "customer_id": 8187626,
        "discount_codes": [],
        "email": "john.doe@test.com",
        "first_name": "John",
        "has_uncommited_changes": false,
        "id": 32172457,
        "last_name": "Doe",
        "line_items": [
            "grams": 0,
            {
            "images": {
                "large": "",
                "medium": "",
                "original": "",
                "small": ""
                },
            "original_price": "100.00",
            "price": "100.00",
            "properties": [],
            "quantity": 3,
            "shopify_product_id": "4441899073674",
            "shopify_variant_id": "31666207588490",
            "sku": "",
            "subscription_id": 6187834,
            "tax_lines": [],
            "title": "Optimum Nutrition Gold Standard Whey Auto renew",
            "type": "SUBSCRIPTION",
            "variant_title": "",
            "vendor": "recharge-test-store"
            }
        ],
        "note": "next order in sequence 1",
        "note_attributes": [],
        "processed_at": "2020-02-05T08:55:39",
        "processor_name": "stripe",
        "requires_shipping": true,
        "scheduled_at": "2020-02-05T00:00:00",
        "shipments_count": 1,
        "shipping_address": {
            "address1": "Bulevar Mihajla Pupina 10",
            "address2": "",
            "city": "Belgrade",
            "company": "BG",
            "country": "Serbia",
            "first_name": "Uros",
            "last_name": "Bijelic",
            "phone": "122211121212",
            "province": "",
            "zip": "11070",
        },
        "shipping_lines": {
            "code": "Standard",
            "description": null,
            "price": "0.00",
            "source": "Subscription",
            "tax_lines": [],
            "title": "Standard"
        },
        "shopify_order_id": "197852934323",
        "status": "SKIPPED",
        "sub_total": null,
        "subtotal_price": "300.0",
        "tags": "Subscription, Subscription Recurring Order",
        "tax_lines": 0,
        "total_discounts": "0.0",
        "total_duties": null,
        "total_line_items_price": "300.00",
        "total_price": "300.00",
        "total_refunds": null,
        "total_tax": 0,
        "total_weight": 2724,
        "transaction_id": "ch_1G8oLuJ2zqasdfd1owLGogae",
        "type": "RECURRING",
        "updated_at": "2020-02-05T09:55:41"
    }
}

This endpoint unskips one or more subscriptions attached to a single queued charge. Must pass a list of subscription_ids to unskip.

Methods accepted: POST

Embedded Route: /tools/recurring/portal/{{ customer.hash }}/charges/<int:charge_id>/unskip?token=${window.customerToken}

Hosted Route: /portal/{{ customer.hash }}/charges/<int:charge_id>/unskip?token=${window.customerToken}

Customer

EXAMPLE USING PROPERTIES

{{ customer.first_name }} {{ customer.last_name }}<br>
{{ customer.email }}

EXAMPLE OUTPUT

John Doe
john.doe@test.com

Customer represents a customer account with a shop.

Customer routes

Routes are used to retrieve, create, or modify existing data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


GET /tools/recurring/portal/<string:customer_hash>/customer

This endpoint renders a template with form that contains current customer information. route details

POST /tools/recurring/portal/<string:customer_hash>/customer

This enpoint updates customers information. route details

Customer object

Property Definition
customer.accepts_marketing
boolean		 "customer.accepts_marketing": "null"
Does the buyer accept marketing, newsletters etc.
customer.analytics_data
object		 "customer.analytics_data": {"utm_params": []}
utm_params will be added to subscription, customer and charge objects after successful processing of the checkout. (utm_params optional)
customer.can_add_payment_method
boolean		 "customer.can_add_payment_method": false
Add a payment method.
customer.created_at
string		 "customer.created_at": "2018-02-21T11:45:58"
The date and time when the customer was created.
customer.deleted_at
string		 "customer.deleted_at": "2019-03-11T10:32:23"
The date and time when the customer was deleted.
customer.email
string		 "customer.email": "john.doe@test.com"
The email address of the customer.
customer.external_sync
object		 "customer.external_sync": null
The external sync of the customer.
customer.first_charge_processed_at
string		 "customer.first_charge_processed_at": "2018-02-21T11:46:02"
Date when first charge is processed for customer.
customer.first_name
string		 "customer.first_name": "John"
The customer's first name.
customer.has_card_error_in_dunning
boolean		 "customer.has_card_error_in_dunning": false
Does have credit card in dunning, can be true and false.
customer.hash
string		 "customer.hash": "818762670d14f56b6f39fd7"
The unique string identifier used in a customers portal link.
customer.id
number		 "customer.id": 8187626
Unique numeric identifier for the customer.
customer.include
object		 "customer.include": {"payment_methods": []}
Includes payment methods for the customer.
customer.last_name
string		 "customer.last_name": "Doe"
The customer's last name.
customer.number_active_subscriptions
number		 "customer.number_active_subscriptions": 8
Numer of active subscriptions for customer.
customer.number_subscriptions
number		 "customer.number_subscriptions": 19
Numer of subscriptions for customer.
customer.phone
string		 "customer.phone": "5551231234"
The customer's phone number.
customer.shopify_customer_id
string		 "customer.shopify_customer_id": "391100760128"
Shopify’s unique identifier for the customer.
customer.updated_at
string		 "customer.updated_at": "2019-05-13T14:19:01"
The date and time when the customer was last updated.

[GET] - Retrieve customer

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}`,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"johndoe@gmail.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-13T14:19:01"
   },
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with form that contains current customer information.

URL: {{ customer_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/customer?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/customer?token=${window.customerToken}

Template file: customer.html

Schema: '{ "customer": {}, "settings": {}, "store": {} }'

Available objects

[POST] - Update customer

POST /customer

(async () => {
  let url = '{{ customer_url }}';
  let data = {
    "first_name":"John",
    "last_name":"Doe",
    "email":"john.Doe@gmail.com"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();


let url = '{{ customer_url }}';
let data = {
  "first_name":"John",
  "last_name":"Doe",
  "email":"john.Doe@gmail.com"
}
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ customer_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    "first_name":"John",
    "last_name":"Doe",
    "email":"john.Doe@gmail.com"
  }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "billing_address1":"101 Washington Street",
      "billing_address2":"",
      "billing_city":"Los Angeles",
      "billing_company":"Recharge",
      "billing_country":"United States",
      "billing_phone":"5623095450",
      "billing_province":"California",
      "billing_zip":"90024",
      "created_at":"2018-02-21T11:45:58",
      "email":"John@rechargeapps.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "has_valid_payment_method":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "processor_type":null,
      "reason_payment_method_not_valid":"NO_PAYMENT_METHOD",
      "shopify_customer_id":"391100760128",
      "status":"ACTIVE",
      "updated_at":"2019-05-13T14:19:01"
   }
}

This enpoint updates customer's first name, last name and email address.

URL: {{ customer_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/customer?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/customer?token=${window.customerToken}

Template file: customer.html

Available objects

Arguments accepted:

Property Type
First Name sting
Last name string
Email string

Discounts

EXAMPLE USING PROPERTIES

{% if address.discount_id %}
  <p>
    Applied discount: {{ address.discount.code }}<br>
    <a href="#" onclick="ReCharge.Discount.remove({{ address.id }}, {{ address.discount_id }});" class="btn">Remove discount</a>
  </p>
{% else %}
  <p>
    <a href="#" onclick="ReCharge.Helpers.toggle('ReChargeForm_applyDiscount_{{ address.id }}'); return false;" class="btn">Add discount</a>
  </p>
  <form method="post" action="{{ address.id | discount_apply_url }}" id="ReChargeForm_applyDiscount_{{ address.id }}" style="display: none;">
    <input type="hidden" name="redirect_url" value="{{ subscription_list_url }}">
    <fieldset>
      <label for="discount_code">Discount code</label>
      <input type="text" name="discount_code" id="discount_code" placeholder="Enter discount code">
      <button type="submit" class="btn"><span>Apply</span></button>
    </fieldset>
  </form>
{% endif %}

EXAMPLE OUTPUT

Applied discount: 20 % to all product
Remove discount

Discount represents a discount object on a shop. Discount are being applied to an address.

Discount routes

Routes are used to retrieve, create, or modify existing data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


POST /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>/apply_discount

This endpoint applies discount to current address. route details

POST /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>/remove_discount

This endpoint removes discount applied to current address. route details

Discount object

Discounts are a child object, a property associated with an Address. Discounts are available by default in subscriptions.html template.

Property Definition
applies_to
string		 "applies_to": null
An indicator of whether the discount applies to product or collection.
applies_to_id
number		 "applies_to_id": null
An indication of the collection or product id to which the discount applies.
applies_to_product_type
string		 "applies_to_product_type": null
An indicator of whether the discount applies to onetimes, subscriptions, or all purchase item types.
applies_to_resource
string		 "applies_to_resource": null
An indicator of the type of resource to which applies_to_id refers.
channel_settings
object		 "api": {can_apply: true}
"checkout_page": {can_apply: true}
"customer_portal": {can_apply: true}
"merchant_portal": {can_apply: true}
A list of channel objects containing information regarding discount behaviors for each.
code
string		 "code": "test123"
The code used to apply the discount.
created_at
string		 "created_at": "2019-07-03T10:06:47"
The date and time when the discount was created.
discount_type
string		 "discount_type": "percentage"
Type of discount mechanic.
duration
string		 "duration": "single_use"
Duration of the discount.
duration_usage_limit
object		 "duration_usage_limit": null
An object containing limitations on a discount based on usage_counts results
ends_at
string		 "ends_at": null
The expiration timestamp of the discount. Past this time the Discount can no longer be redeemed. After ends_at the status of the Discount will go from active to disabled.
external_discount_id
object		 "external_discount_id": null
An object containing external ids of the discount.
external_discount_source
string		 "external_discount_source": null
The external discount source.
first_time_customer_restriction
boolean		 "first_time_customer_restriction": null
Discount can be used on checkout for customer that still don’t exist in Recharge database.
id
number		 "id": 13350570
Unique numeric identifier for the discount in Recharge.
once_per_customer
boolean		 "once_per_customer": true
The code could be applied once.
prerequisite_subtotal_min
string		 "prerequisite_subtotal_min": null
The minimum cart subtotal needed for the discount to be applicable. duration has to be single_use and the discount must apply to the entire order.
starts_at
string		 "starts_at": "2019-07-04T00:00:00"
The date when the discount becomes active.
status
string		 "status": "enabled"
The status of the discount.
times_used
number		 "times_used": 0
Number of times discount has been used.
updated_at
string		 "updated_at": "2019-07-03T10:06:47"
The date when the discount is updated.
usage_limit
number		 "usage_limit": null
Discount usage limit.
value
number		 "value": 10
The discounted value to be applied.

[GET] - List of discounts

GET /request_objects

(async () => {
  let schema = '{ "discounts": [], "customer": {} , "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "discounts": [], "customer": {} , "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });


$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash}}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
}).done(function(response) {
  data: { schema: '{ "discounts": [], "customer": {} , "settings": {}, "store": {} }' }
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

  {
    "discounts": [
      {
        "applies_to": null,
        "applies_to_id": null,
        "applies_to_product_type": "ALL",
        "applies_to_resource": null,
        "channel_settings": {
          "api": {"can_apply": true},
          "checkout_page": {"can_apply": true},
          "customer_portal": {"can_apply": true},
          "merchant_portal": {"can_apply": true},
        },
        "code": "TIMESUSED",
        "created_at": "2020-05-27T08:32:43",
        "discount_type": "percentage",
        "duration": "forever",
        "duration_usage_limit": null,
        "ends_at": null,
        "external_discount_id": null,
        "external_discount_source": null,
        "first_time_customer_restriction": null,
        "id": 281878231,
        "once_per_customer": false,
        "prerequisite_subtotal_min": null,
        "starts_at": "2020-05-26T00:00:00",
        "status": "enabled",
        "times_used": 0,
        "updated_at": "2020-05-27T08:32:43",
        "usage_limit": null,
        "value": 10
      },
      {
        "applies_to: null",
        "applies_to_id: null",
        "applies_to_product_type": "SUBSCRIPTION",
        "applies_to_resource": null,
        "channel_settings": {
          "api": {"can_apply": true},
          "checkout_page": {"can_apply": true},
          "customer_portal": {"can_apply": true},
          "merchant_portal": {"can_apply": true},
        },
        "code": "10% off",
        "created_at": "2020-01-09T13:02:29",
        "discount_type": "percentage",
        "duration": "single_use",
        "duration_usage_limit": null,
        "ends_at": null,
        "first_time_customer_restriction": null,
        "id": 22116424123,
        "once_per_customer": true,
        "prerequisite_subtotal_min": null,
        "starts_at": "2020-01-08T00:00:00",
        "status": "disabled",
        "times_used": 0,
        "updated_at": "2020-01-09T14:02:29"
        "usage_limit": null,
        "value": 10,
      },
      {
        "applies_to: null",
        "applies_to_id: null",
        "applies_to_product_type": "ALL",
        "applies_to_resource": null,
        "channel_settings": {
          "api": {"can_apply": true},
          "checkout_page": {"can_apply": true},
          "customer_portal": {"can_apply": true},
          "merchant_portal": {"can_apply": true},
        },
        "code": "checkout",
        "created_at": "2020-04-15T09:45:13",
        "discount_type": "fixed_amount",
        "duration": "single_use",
        "duration_usage_limit": null,
        "ends_at": null,
        "first_time_customer_restriction": null,
        "id": 3212527315,
        "once_per_customer": false,
        "prerequisite_subtotal_min": null,
        "starts_at": "2020-04-14T00:00:00",
        "status": "enabled",
        "times_used": 0,
        "updated_at": "2020-04-15T09:45:13",
        "usage_limit": null,
        "value": 5,
      },
      {
        "applies_to": "shopify_product"
        "applies_to_id": 47751111222312,
        "applies_to_product_type": "ALL",
        "applies_to_resource": "shopify_product",
        "channel_settings": {
          "api": {"can_apply": true},
          "checkout_page": {"can_apply": true},
          "customer_portal": {"can_apply": true},
          "merchant_portal": {"can_apply": true},
        },
        "code": "testing",
        "created_at": "2020-05-20T10:51:15",
        "discount_type": "percentage",
        "duration": "forever",
        "duration_usage_limit": null,
        "ends_at": null,
        "external_discount_id": null,
        "external_discount_source": null,
        "first_time_customer_restriction": null,
        "id": 28019689,
        "once_per_customer": false,
        "prerequisite_subtotal_min": null,
        "starts_at": "2020-05-19T00:00:00",
        "status": "enabled",
        "times_used": 0,
        "updated_at": "2020-05-20T10:51:15",
        "usage_limit": null,
        "value": 10,
      }
    ]
  },
  "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"johndoe@gmail.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-13T14:19:01"
  },
  "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }

List all discounts for the current customer.

Methods accepted: GET

Schema: '{ "discounts": [], "customer": {} , "settings": {}, "store": {} }'

[POST] - Apply discount

POST /addresses/<int:address_id>/apply_discount

(async () => {
  let url = '{{ discount_apply_url }}';
  let data = {
    "discount_code":"20 % to all product"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ discount_apply_url }}';
let data = {
  "discount_code":"20 % to all product"
}
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ discount_apply_url }}',
  type: 'post',
  dataType: 'json',
  data: {
  "discount_code":"20 % to all product"
}
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"Suite 404",
      "cart_attributes":[

      ],
      "cart_note":"",
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2018-02-21T11:46:01",
      "customer_id":8187626,
      "discount_id":10986334,
      "first_name":"John",
      "id":7976732,
      "last_name":"Doe",
      "note_attributes":[

      ],
      "original_shipping_lines":[
         {
            "code":"Priority",
            "price":"7.80",
            "title":"Priority Mail"
         }
      ],
      "phone":"3103103101",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-05-16T09:32:16",
      "zip":"90025"
   }
}

This endpoint applies discount to the current address that is related to an active subscription.

URL: {{ discount_apply_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>/apply_discount?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses/<int:address_id>/apply_discount?token=${window.customerToken}

Template file: subscriptions.html

Available objects:

Arguments accepted:

Property Type
Discount Code string

* = required

[POST] - Remove discount

POST /addresses/<int:address_id>/remove_discount

(async () => {
  let url = '{{ discount_remove_url }}';

  try {
    const response = await axios.post(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ discount_remove_url }}';
let options = {
  method: "post",
  headers: {
    'Content-Type': 'application/json'
  }
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ discount_remove_url }}',
  type: 'post',
  dataType: 'json'
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "address":{
      "address1":"101 Washington Street",
      "address2":"Suite 204",
      "cart_attributes":[

      ],
      "cart_note":"",
      "city":"Los Angeles",
      "company":"Recharge",
      "country":"United States",
      "created_at":"2018-02-21T11:46:01",
      "customer_id":8187626,
      "discount_id":31231231,
      "first_name":"John",
      "id":7976732,
      "last_name":"Doe",
      "note_attributes":[

      ],
      "original_shipping_lines":[
         {
            "code":"Priority",
            "price":"7.80",
            "title":"Priority Mail"
         }
      ],
      "phone":"5553103101",
      "province":"California",
      "shipping_lines_override":null,
      "updated_at":"2019-05-16T09:35:06",
      "zip":"90025"
   }
}

This endpoint removes discount applied to the current address that is related to an active subscription.

URL: {{ discount_remove_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/addresses/<int:address_id>/remove_discount?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/addresses/<int:address_id>/remove_discount?token=${window.customerToken}

Template file: subscriptions.html

Available objects:

One time products

EXAMPLE USING PROPERTIES

{% if onetime.next_charge_scheduled_at %}
    {{ onetime.next_charge_scheduled_at | date('%m/%d/%Y') }}
    <a href="#" onclick="ReCharge.Helpers.toggle('ReChargeForm_date'); return false;">Edit</a>
{% else %}
    Error
{% endif %}

EXAMPLE OUTPUT

12/12/2019 Edit

One time products routes

Routes are used to retrieve, create, or modify existing data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


POST /tools/recurring/portal/<string:customer_hash>/onetimes

This endpoint creates a new one time product for customer. route details

GET /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>

This endpoint renders a template with form for updating onetime product object. route details

POST /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>

This enpoint updates current onetime product for the customer. route details

POST /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>/set_next_charge_date

This endpoint renders a template with form for upating next charge date of current onetime product. route details

POST /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>/cancel

This endpoint cancels onetime product. route details

One time product object

Property Definition
onetime.address_id
number		 "onetime.address_id": 32172754
Unique numeric identifier for the address the One Time Product is associated with.
onetime.created_at
string		 "onetime.created_at": "2019-05-24T13:17:45"
The time One Time Product was first created.
onetime.customer_id
number		 "onetime.customer_id": 8187626
Unique numeric identifier for the customer the One Time Product is tied to.
onetime.id
number		 "onetime.id": 43482259
One Time id.
onetime.next_charge_scheduled_at
string		 "onetime.next_charge_scheduled_at": "2019-08-08T00:00:00"
Date of the One Time Product execution.
onetime.presentment_currency
string		 "onetime.presentment_currency": null
The currency on the subscription contract in Shopify.
onetime.price
number		 "onetime.price": 120
The price of the item before discounts, taxes, or shipping have been applied.
onetime.product_title
string		 "onetime.product_title": "Bare Box - 6 Month Plan"
The name of the product in a shop’s catalog.
onetime.properties
array		 "name": "grind"
"value": "drip"

A list of line item objects, each one containing information about the onetime product. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself.
onetime.quantity
number		 "onetime.quantity": 1
The number of items on the subscription.
onetime.recharge_product_id
number		 "onetime.recharge_product_id": 1222682
Unique number identifier of the product in Recharge.
onetime.shopify_product_id
number		 "onetime.shopify_product_id": 506021216320
Unique number identifier of the product in Shopify.
onetime.shopify_variant_id
number		 "onetime.shopify_variant_id": 5424189866048
Unique number identifier of the product variant in Shopify.
onetime.sku
string		 "onetime.sku": null
A unique identifier of the item in the fulfillment.
onetime.status
string		 "onetime.status": "ONETIME"
The status of the One Time Product.
onetime.updated_at
string		 "onetime.updated_at": "2019-05-24T15:30:52"
The time One Time Product was last updated.
onetime.variant_title
string		 "onetime.variant_title": "x-small"
The name of the variant in a shop’s catalog.

[GET] - Retrieve one time product

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_sources": { "customer_id": <int:customer_id> }, "onetime":{ "id": <int:onetime_id>, "products": {"base_source":"shopify"}, "address": {"id": <int:address_id>} }, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_sources": { "customer_id": <int:customer_id> }, "onetime":{ "id": <int:onetime_id>, "products": {"base_source":"shopify"}, "address": {"id": <int:address_id>} }, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });


$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_sources": { "customer_id": <int:customer_id> }, "onetime":{ "id": <int:onetime_id>, "products": {"base_source":"shopify"}, "address": {"id": <int:address_id>} }, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"corey@rechargeapps.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":12,
      "number_subscriptions":23,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-24T12:59:21"
   },
   "onetime":{  
      "address":{  
         "address1":"1933 Manning",
         "address2":"204",
         "cart_note":"Updated phone",
         "city":"Los Angeles",
         "company":"Recharge",
         "country":"United States",
         "created_at":"2019-04-30T15:25:20",
         "customer_id":8187626,
         "discount_id":null,
         "first_name":"Recharge",
         "id":32172754,
         "last_name":"Test",
         "note_attributes": [

         ],
         "phone":"3103102221",
         "province":"California",
         "shipping_lines_override":null,
         "updated_at":"2019-05-20T17:12:56",
         "zip":"90025"
      },
      "address_id":32172754,
      "created_at":"2019-05-24T13:54:47",
      "customer_id":8187626,
      "id":43483770,
      "next_charge_scheduled_at":"2019-10-10T00:00:00",
      "price":120.0,
      "product":{  
         "collection_id":106921,
         "created_at":"2019-05-24T12:45:09",
         "discount_amount":0.0,
         "discount_type":"percentage",
         "handle":"bare-box-6-month-plan",
         "id":1222682,
         "images":{  
            "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_869e6595-cb3b-40a4-9dd8-60d55904d11a_large.jpg",
            "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_869e6595-cb3b-40a4-9dd8-60d55904d11a_medium.jpg",
            "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_869e6595-cb3b-40a4-9dd8-60d55904d11a.jpg",
            "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_869e6595-cb3b-40a4-9dd8-60d55904d11a_small.jpg"
         },
         "inventory_policy":{  
            "one_time":"1",
            "subscription":"1"
         },
         "product_id":506021216320,
         "shopify_details":{  
            "body_html":"<meta charset=\"utf-8\"><span>Looking to mix things up? Every month we'll send you a surprise box filled with all kinds of natural and organic goodies. Each box will contain speciality supplements, beauty supplies,\u00a0clothes and accessories, and many more products\u00a0to help you live your best life. All products are ethically and humanely sourced.</span>",
            "created_at":"2018-02-16T11:02:15-05:00",
            "handle":"bare-box-6-month-plan",
            "image":{  
               "alt":null,
               "created_at":"2018-02-16T11:02:18-05:00",
               "height":1060,
               "position":1,
               "shopify_id":1555303825472,
               "shopify_product_id":506021216320,
               "shopify_variant_ids":[  

               ],
               "src":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_869e6595-cb3b-40a4-9dd8-60d55904d11a.jpg?v=1518796938",
               "updated_at":"2018-02-16T11:02:18-05:00",
               "width":1060
            },
            "images":[  
               {  
                  "alt":null,
                  "created_at":"2018-02-16T11:02:18-05:00",
                  "height":1060,
                  "position":1,
                  "shopify_id":1555303825472,
                  "shopify_product_id":506021216320,
                  "shopify_variant_ids":[  

                  ],
                  "src":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_869e6595-cb3b-40a4-9dd8-60d55904d11a.jpg?v=1518796938",
                  "updated_at":"2018-02-16T11:02:18-05:00",
                  "width":1060
               }
            ],
            "options":[  
               {  
                  "name":"T-Shirt Size",
                  "position":1,
                  "shopify_id":651242405952,
                  "shopify_product_id":506021216320,
                  "values":[  
                     "x-small",
                     "small",
                     "medium",
                     "large",
                     "x-large"
                  ]
               }
            ],
            "product_type":"",
            "published_at":"2018-02-16T11:01:42-05:00",
            "shopify_id":506021216320,
            "tags":"",
            "title":"Bare Box - 6 Month Plan",
            "updated_at":"2019-05-24T12:45:33-04:00",
            "variants":[  
               {  
                  "barcode":"",
                  "compare_at_price":null,
                  "created_at":"2018-02-16T11:02:16-05:00",
                  "fulfillment_service":"manual",
                  "grams":1814,
                  "inventory_management":null,
                  "inventory_policy":"deny",
                  "inventory_quantity":-1,
                  "option1":"x-small",
                  "option2":null,
                  "option3":null,
                  "position":1,
                  "presentment_prices":null,
                  "price":"120.00",
                  "requires_shipping":true,
                  "shopify_id":5424189866048,
                  "shopify_image_id":null,
                  "shopify_product_id":506021216320,
                  "sku":"001",
                  "taxable":true,
                  "title":"x-small",
                  "updated_at":"2019-05-24T12:45:29-04:00",
                  "weight":4.0,
                  "weight_unit":"lb"
               },
               ...
            ],
            "vendor":"bare-supplements"
         },
         "shopify_product_id":506021216320,
         "subscription_defaults":{  
            "charge_interval_frequency":1,
            "cutoff_day_of_month":null,
            "cutoff_day_of_week":null,
            "expire_after_specific_number_of_charges":null,
            "modifiable_properties": [

            ],
            "number_charges_until_expiration":null,
            "order_day_of_month":0,
            "order_day_of_week":null,
            "order_interval_frequency_options":[  
               "1", "2", "3", "4", "5"
            ],
            "order_interval_unit":"Months",
            "storefront_purchase_options":"subscription_and_onetime"
         },
         "title":"Bare Box - 6 Month Plan",
         "updated_at":"2019-05-24T12:45:33"
      },
      "product_title":"Bare Box - 6 Month Plan",
      "properties":[  

      ],
      "quantity":1,
      "recharge_product_id":1222682,
      "shopify_product_id":506021216320,
      "shopify_variant_id":5424189866048,
      "sku":null,
      "status":"ONETIME",
      "updated_at":"2019-05-24T13:54:47",
      "variant_title":"x-small"
   },
   "payment_sources":[  
      {  
         "billing_address":{  
            "address1":"607 Midvale Ave",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name":"Corey",
            "last_name":"Capetillo",
            "phone":"5623095450",
            "province":"California",
            "zip":"90024"
         },
         "card_brand":"visa",
         "card_exp_month":1,
         "card_exp_year":2023,
         "card_last4":"4242",
         "cardholder_name": "Recharge Test"
         "customer_id":8187626,
         "has_card_error_in_dunning":false,
         "id": 1,
         "payment_token": null,
         "payment_type":"credit",
         "processor_name":"stripe",
         "status":"active",
         "status_reason":null
      }
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with form for updating onetime product object.

URL: {{ onetime_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/onetimes/<int:onetime_id>?token=${window.customerToken}

Template file: onetime.html

Schema: '{ "customer": {}, "payment_sources": { "customer_id": <int:customer_id> }, "onetime":{ "id": <int:onetime_id>, "products": {"base_source":"shopify"}, "address": {"id": <int:address_id>} }, "settings": {}, "store": {} }'

Available template objects:

[POST] - Create one time product

POST /onetimes 

(async () => {
  let url = '{{ onetime_list_url }}';
  let data = {
    shopify_variant_id: 5424189866048,
    address_id: 32172754,
    quantity: 1,
    next_charge_scheduled_at: "2019-12-12"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ onetime_list_url }}';
let data = {
  shopify_variant_id: 5424189866048,
  address_id: 32172754,
  quantity: 1,
  next_charge_scheduled_at: "2019-12-12"
}
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ onetime_list_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    shopify_variant_id: 5424189866048,
    address_id: 32172754,
      quantity: 1,
    next_charge_scheduled_at: "2019-12-12"
  }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "onetime":{  
      "address_id":32172754,
      "created_at":"2019-05-24T13:54:47",
      "customer_id":8187626,
      "id":43483770,
      "next_charge_scheduled_at":"2019-12-12T00:00:00",
      "price": 5,
      "product_title":"Bare Box - 6 Month Plan",
      "properties":[  

      ],
      "quantity":1,
      "recharge_product_id":1222682,
      "shopify_product_id":506021216320,
      "shopify_variant_id":5424189866048,
      "sku":null,
      "status":"ONETIME",
      "updated_at":"2019-05-24T13:54:47",
      "variant_title":"x-small"
   }
}

This endpoint creates a new one time product for the customer.

URL: {{ onetime_list_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/onetimes?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/onetimes?token=${window.customerToken}

Template file: No template file

Available template objects: No available template objects

Arguments accepted:

|Property| Type| |-|-| |shopify_variant_id *| number | |address_id *| number | |quantity *| number | |next_charge_scheduled_at *| string |

* = required

[POST] - Update one time product

POST /onetimes/<int:onetime_id>

(async () => {
  let url = '{{ onetime_url }}';
  let data = {
    quantity: 2,
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ onetime_url }}';
let data = {
  quantity: 2,
}
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ onetime_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    quantity: 2,
  }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "onetime":{  
      "address_id":32172754,
      "created_at":"2019-05-24T13:54:47",
      "customer_id":8187626,
      "id":43483770,
      "next_charge_scheduled_at":"2020-03-03T00:00:00",
      "price":120.0,
      "product_title":"Bare Box - 6 Month Plan",
      "properties":[  

      ],
      "quantity":2,
      "recharge_product_id":1222682,
      "shopify_product_id":506021216320,
      "shopify_variant_id":5424189866048,
      "sku":null,
      "status":"ONETIME",
      "updated_at":"2019-05-24T14:55:20",
      "variant_title":"Bare Box - One Time purchase - x-small"
   }
}

This enpoint updates current onetime product for the customer.

URL: {{ onetime_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/onetimes/<int:onetime_id>?token=${window.customerToken}

Template file: onetime.html

Available template objects:

Arguments accepted:

|Property| Type| |-|-| |next_charge_scheduled_at | string | |quantity | number | |shopify_variant_id | number | |sku | string | |properties | array of dictionary objects |

* = required

[POST] - Set next charge date for one time product

POST /onetimes/<int:onetime_id>/set_next_charge_date 

(async () => {
  let url = '{{ onetime_set_next_charge_date_url }}';
  let data = {
    next_charge_scheduled_at: "2019-12-12"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ onetime_set_next_charge_date_url }}';
let data = {
  next_charge_scheduled_at: "2019-12-12"
}
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ onetime_set_next_charge_date_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    next_charge_scheduled_at: "2019-12-12"
  }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "onetime":{  
      "address_id":32172754,
      "created_at":"2019-05-24T13:17:45",
      "customer_id":8187626,
      "id":43482259,
      "next_charge_scheduled_at":"2019-12-12T00:00:00",
      "price":120.0,
      "product_title":"Bare Box - 6 Month Plan",
      "properties":[  

      ],
      "quantity":1,
      "recharge_product_id":1222682,
      "shopify_product_id":506021216320,
      "shopify_variant_id":5424189866048,
      "sku":null,
      "status":"ONETIME",
      "updated_at":"2019-05-24T15:30:52",
      "variant_title":"x-small"
   }
}

This endpoint renders a template with form for upating next charge date of current onetime product.

URL: {{ onetime_set_next_charge_date_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>/set_next_charge_date?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/onetimes/<int:onetime_id>/set_next_charge_date?token=${window.customerToken}

Template file: onetime.html

Available template objects:

Arguments accepted:

|Property| Type| |-|-| |next_charge_scheduled_at *| string |

* = required

[POST] - Cancel one time product

POST /onetimes/<int:onetime_id>/cancel 

(async () => {
  let url = '{{ onetime_cancel_url }}';

  try {
    const response = await axios.post(url);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ onetime_cancel_url }}';
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  }
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ onetime_cancel_url }}',
  type: 'post',
  dataType: 'json'
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{ }

This endpoint cancels onetime product.

URL: {{ onetime_cancel_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/onetimes/<int:onetime_id>/cancel?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/onetimes/<int:onetime_id>/cancel?token=${window.customerToken}

Template file: No template file

Available template objects: No available template objects

Orders

EXAMPLE USING PROPERTIES

{% for order in orders | sort(attribute='shopify_order_number', reverse=True) %}

   {{ order.processed_at | date('%b %-d, %Y') }}

   <a href="{{ order.id | order_url }}">{{ order.shopify_order_number }}</a>

   {{ order.total_price | money }}

{% endfor %}

EXAMPLE OUTPUT

February 21, 2019
1002
$41.57

An order is created after a charge is successfully processed.

Getting an order

EXAMPLE INPUT

{% for order in orders %}
  {{ order.id }}
{% endfor %}

EXAMPLE OUTPUT

1001
1002
1003

You can access all order objects by looping over the orders parent object.

Order routes

Routes are used to retrieve data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


GET /tools/recurring/portal/<string:customer_hash>/orders

This endpoint renders a template with a list of orders placed by the current customer. route details

GET /tools/recurring/portal/<string:customer_hash>/orders/<int:order_id>

This endpoint renders a template with order details for the current order. route details

POST /tools/recurring/portal/<string:customer_hash>/orders/<int:order_id>/delay

This endpoint will delay the prepaid order by one interval. route details

Order object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
order.address_id
number		 "order.address_id": 7976732
The id of the customer shipping address that this order is tied to.
order.billing_address
object		 "address1": "101 Washington Street"
"address2": "Suite 404"
"city": "Los Angeles"
"company": "bootstrap"
"country": "United States"
"first_name": "John"
"last_name": "Doe"
"phone": 5553103101
"province": "California"
"zip": 90025

This is all of the billing information related to the order:
  • [string] address1: The street address of the billing address.
  • [string] address2: An optional additional field for the street address of the billing address.
  • [string] city: The city of the billing address.
  • [string] company: The company of the person associated with the billing address.
  • [string] country: The name of the country of the billing address.
  • [string] first_name: The first name of the person associated with the payment method.
  • [string] last_name: The last name of the person associated with the payment method.
  • [string] phone: The phone number associated with the billing address.
  • [string] province: The name of the state or province of the billing address.
  • [string] zip:The zip or postal code of the billing address.
order.browser_ip
string		 "order.browser_ip": null
The client details.
order.charge_id
number		 "order.charge_id": 41955283
The unique numeric identifier of the charge.
order.charge_status
string		 "order.charge_status": "SUCCESS"
The valid values are “SUCCESS”, “REFUNDED”, “PARTIALLY_REFUNDED”.
order.created_at
string		 "order.created_at": "2018-02-21T11:46:02"
The date when the order was created.
order.currency
string		 "order.currency": "USD"
Order currency.
order.customer
object		 "accepts_marketing": false
"email": "john.Doe@gmail.com"
"first_name": "John"
"last_name": "Doe"
"phone": null
"send_email_welcome": false
"verified_email": true
order.customer_id
number		 "order.customer_id": 8059036
The unique numeric identifier of the customer.
order.discount_codes
string		 "order.discount_codes": []
Discount codes applied on an order.
order.email
string		 "order.email": "teststore.myshopify.com"
The email address of the customer.
order.error
string		 "order.error": ""
Displays an error of the order.
order.first_name
string		 "order.first_name": "Recharge"
The first name of the customer.
order.hash
string		 "order.hash": "818762670d14f56b6f39fd7"
The unique string identifier used in a customers portal link.
order.id
integer		 "order.id": 30999220
The unique numeric identifier for the order.
order.include
object		 "order_modifications": [{
"charge_id": 479471048,
"created_at": "2022-11-30T10:46:56",
"id": 151,
"modifications": {
"line_items": [{
"line_item_id": 1,
"modification_type": "delete",
"modifications": [{
"attribute": "quantity",
"created_at": "2022-11-30T10:45:08",
"previous_value": "2",
"reason": "Removed due to inventory",
"value": null
}],
"subscription_id": 203309206
},
{
"line_item_id": 2,
"modification_type": "update",
"modifications": [{
"attribute": "quantity",
"created_at": "2022-11-30T10:45:09",
"previous_value": "3",
"reason": "Quantity reduced due to inventory",
"value": "2"
}],
"subscription_id": 203309207
}]
},
"order_id": 310319778,
"updated_at": "2022-11-30T10:47:07"
}]
Object that contains information about order modifications:
  • [array] order_modifications: Array of objects containing orders that have been modified.
  • [number] charge_id: Id of the modified charge.
  • [string] created_at: Date when the order was modified.
  • [number] id: Id of the modification object.
  • [object] modifications: Object containing modified line items.
  • [array] line_items: Array of objects containing modifitations of line items.
  • [number] line_item_id: Id of modified line item.
  • [string] modification_type: Type of modification which can be either "Delete" or "Update".
  • [array] modifications: Array of objects containing information about the modifications done to the line item.
  • [string] attribute: Which attribute has been updated.
  • [string] created_at: Date when the line item was modified.
  • [string] previous_value: Previous value that has been modified.
  • [string] reason: Reason for the modification.
  • [string] value: New value after modification.
  • [number]subscription_id: Id of the subscription that was modified.
  • [number] order_id: Id of the order that was moidified.
  • [string] updated_at: Date when the order was modified.
order.is_prepaid
number		 "order.is_prepaid": 0
The order that has been paid for a pre-determined number of days / weeks / months. 0 = No, 1 = Yes.
order.last_name
string		 "order.last_name": "Doe"
The last name of the customer.
order.line_items
array		 "external_inventory_policy": "bypass"
"grams": 0,
"images": { large: "", medium: "", original: "", small: ""},
"price": 4.5,
"product_title": "Bricks 10.00% Off Auto renew",
"properties": [],
"quantity": 1,
"shopify_product_id": 505472712768,
"shopify_variant_id": 5420805816384,
"sku": 13579,
"subscription_id": 11770822,
"tax_lines": [],
"title": "Bricks 10.00% Off Auto renew (Ships every 30 days)",
"variant_title": "1",

A list of line item objects, each one containing information about an item in the order:
  • [string] external_inventory_policy: The inventory behavior policy, according to the store-level setting within Recharge.
  • [number] grams: The weight of the product.
  • [object] images: Object that contains images.
  • [string] price: The price of the product.
  • [string] product_title: The title of the product.
  • [array] properties: A list of line item objects, each one containing information about the subscription. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself.
  • [number] quantity: The quantity of the product.
  • [string] shopify_product_id: The id of the Shopify product.
  • [string] shopify_variant_id: The id of the Shopify variant.
  • [string] sku: Stock keeping unit of the product.
  • [number] subscription_id: The unique numeric identifier for a subscription.
  • [array] tax_lines: An array of tax lines.
  • [string] title: The title of the product.
  • [string] variant_title: The title of the product variant.
order.note
string		 "order.note": null
The note that that will be passed to the “note” field of orders made within the address.
order.note_attributes
string		 "order.note_attributes": []
Extra information that is added to the address. Each array entry must contain a hash with “name” and “value” keys.
order.processed_at
string		 "order.processed_at": "2018-02-15T11:57:19"
The date when the order was submitted.
order.scheduled_at
string		 "order.scheduled_at": "2018-02-15T00:00:00"
The date when the order will ship.
order.shipping_address object "address1": "101 Washington Street"
"address2": "Suite 404"
"city": "Los Angeles"
"company": "bootstrap"
"country": "United States"
"first_name": "John"
"last_name": "Doe"
"phone": "3103103101"
"province": "California"
"zip": "90025"

The mailing address where the order will be shipped to:
  • [string] address1: The street address of the shipping address.
  • [string] address2: An optional additional field for the street address of the shipping address.
  • [string] city: The city of the shipping address.
  • [string] company: The company of the person associated with the shipping address.
  • [string] country: The name of the country of the shipping address.
  • [string] first_name: The first name of the person associated with the shipping address.
  • [string] last_name: The last name of the person associated with the shipping address.
  • [string] phone: The phone number associated with the shipping address.
  • [string] province: The name of the state or province of the shipping address.
  • [string] zip: The zip or postal code of the shipping address.
order.shipping_lines
array		 "code": "Priority"
"description": null
"price": "7.80"
"source": "shopify"
"tax_lines": []
"title": "Priority Mail"

The original shipping used for the address when the store has fixed shipping rates.
  • [string] code: A reference to the shipping used.
  • [string] description: The description of shipping lines.
  • [string] price: The price of this shipping used.
  • [string] source: The source of shipping lines. Available only for stores using the Shopify integration (SCI).
  • [array] tax_lines: Tax lines array.
  • [string] title: The title of the shipping used.
order.shopify_cart_token
string		 "order.shopify_cart_token": "02a2d4408ce577f8d0362791fb42ba2e"
Shopify cart token for an order.
order.shopify_customer_id
string		 "order.shopify_customer_id": "123227119987"
The unique numeric identifier for Shopify customer.
order.shopify_order_id
string		 "order.shopify_order_id": 359467483200
The unique numeric identifier within Shopify for the order.
order.shopify_order_number
number		 "order.shopify_order_number": 1001
The unique order number within Shopify.
order.status
string		 "order.status": "SUCCESS"
The status of creating the order within Shopify. The valid values are “SUCCESS”, “QUEUED”, “ERROR”, “REFUNDED”, “SKIPPED”.
order.subtotal_price
string		 "order.subtotal_price": "33.77"
Subtotal price for an order.
order.tags
string		 "order.tags": "Subscription, Subscription First Order"
Custom tags for an order.
order.tax_lines
array		 "order.tax_lines": []
Tax lines for an order.
order.total_discounts
string		 "order.total_discounts": null
Total discount applied on order.
order.total_line_items_price
string		 "order.total_line_items_price": null
Total line items price for an order.
order.total_price
string		 "order.total_price": "11"
The sum of all of the prices of the items in the order with taxes and discounts included (must be positive).
order.total_refunds
string		 "order.total_refunds": null
Total order refunds.
order.total_tax
number		 "order.total_tax": 0
Taxes calculated for order.
order.total_weight
number		 "order.total_weight": 2721
Total weight of product.
order.transaction_id
string		 "order.transaction_id": "ch_1By0jCJ2zqHvZRd1OOT2qHOx"
The unique alphanumeric identifier of transaction.
order.type
string		 "order.type": "CHECKOUT"
Shows if order was made from checkout or a recurring charge. The valid values are “CHECKOUT” or “RECURRING”. In the event that only a onetime product is on the order and the value is "RECURRING" then the order was processed as an off-session transaction and not through checkout.
order.updated_at
string		 "order.updated_at": "2018-02-21T12:46:02"
The date when the order was last updated.

[GET] - List of orders

GET /request_objects

(async () => {
  let schema = '{ "orders": { "status": "SUCCESS", "sort_by": "shipped_date-desc" }, "customer": {}, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "orders": { "status": "SUCCESS", "sort_by": "shipped_date-desc" }, "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "orders": { "status": "SUCCESS", "sort_by": "shipped_date-desc" }, "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-04-30T15:11:43"
   },
   "orders":[
      {
         "address_id":7976732,
         "billing_address":{
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"los angeles",
            "company":"bootstrap",
            "country":"United States",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5553103101",
            "province":"California",
            "zip":"90025"
         },
         "browser_ip": null,
         "charge_id":42723497,
         "charge_status":"SUCCESS",
         "created_at":"2018-02-21T11:46:02",
         "currency": "USD",
         "customer_id":8187626,
         "customer": {
            "accepts_marketing": false,
            "email": "john.Doe@gmail.com",
            "first_name": "John",
            "last_name": "Doe",
            "phone": null,
            "send_email_welcome": false,
            "verified_email": true
         },
         "discount_codes":[
            "amount": "10.00",
            "code": "summerDiscount",
            "type": "percentage"
         ],
         "email":"john.doe@test.com",
         "error": "",
         "first_name":"John",
         "hash":"818762670d14f56b6f39fd7",
         "id":31541603,
         "include": {
            "order_modifications": [{
            "charge_id": 479471048,
            "created_at": "2022-11-30T10:46:56",
            "id": 151,
            "modifications": {
               "line_items": [{
                  "line_item_id": 1,
                  "modification_type": "delete",
                  "modifications": [{
                     "attribute": "quantity",
                     "created_at": "2022-11-30T10:45:08",
                     "previous_value": "2",
                     "reason": "Removed due to inventory",
                     "value": null
                  }],
                  "subscription_id": 203309206
               },
               {
                  "line_item_id": 2,
                  "modification_type": "update",
                  "modifications": [{
                     "attribute": "quantity",
                     "created_at": "2022-11-30T10:45:09",
                     "previous_value": "3",
                     "reason": "Quantity reduced due to inventory",
                     "value": "2"
                  }],
                  "subscription_id": 203309207
               }]
            },
            "order_id": 310319778,
            "updated_at": "2022-11-30T10:47:07"
            }]
         },
         "is_prepaid":0,
         "last_name":"Doe",
         "line_items":[
            {
               "external_inventory_policy": "bypass",
               "grams":907,
               "images":{
                  "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_large.jpg",
                  "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_medium.jpg",
                  "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep.jpg",
                  "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_small.jpg"
               },
               "price":12.99,
               "product_title":"Bare Sleep",
               "properties":[

               ],
               "quantity":1,
               "shopify_product_id":"505545949248",
               "shopify_variant_id":"5421270171712",
               "sku":"12347",
               "subscription_id":11959568,
               "tax_lines": [],
               "title":"Bare Sleep",
               "variant_title":""
            },
            {
               "external_inventory_policy": "bypass",
               "grams":907,
               "images":{
                  "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_large.jpg",
                  "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_medium.jpg",
                  "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep.jpg",
                  "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_small.jpg"
               },
               "price":10.39,
               "product_title":"Bare Sleep  20.00% Off Auto renew",
               "properties":[
                  {
                     "name":"shipping_interval_frequency",
                     "value":"1"
                  },
                  {
                     "name":"shipping_interval_unit_type",
                     "value":"Months"
                  }
               ],
               "quantity":2,
               "shopify_product_id":"505545949248",
               "shopify_variant_id":"5421270171712",
               "sku":"12347",
               "subscription_id":11959568,
               "tax_lines": [],
               "title":"Bare Sleep  20.00% Off Auto renew (Ships every 1 Months)",
               "variant_title":""
            }
         ],
         "note":null,
         "note_attributes":[

         ],
         "processed_at":"2018-02-21T11:46:02",
         "scheduled_at":"2018-02-21T00:00:00",
         "shipping_address":{
            "address1":"101 Washington Street",
            "address2":"204",
            "city":"los angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5553103101",
            "province":"California",
            "zip":"90025"
         },
         "shipping_lines":[
            {
               "code":"Priority",
               "description":null,
               "price":"7.80",
               "source":"Subscription",
               "tax_lines":"[]",
               "title":"Priority Mail"
            }
         ],
         "shopify_cart_token":"02a2d4408ce577f8d0362791fb42ba2e",
         "shopify_customer_id": "123227119987",
         "shopify_order_id":"363227119680",
         "shopify_order_number":1002,
         "status":"SUCCESS",
         "subtotal_price":"33.77",
         "tags":"Subscription, Subscription First Order",
         "tax_lines":[

         ],
         "total_discounts":null,
         "total_line_items_price":null,
         "total_price":"41.57",
         "total_refunds":null,
         "total_tax":0.0,
         "total_weight":2721,
         "transaction_id":"ch_1By0jCJ2zqHvZRd1OOT2qHOx",
         "type":"CHECKOUT",
         "updated_at":"2018-02-21T12:46:02"
      }
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a list of orders placed by the current customer.

URL: {{ order_list_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/orders?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/orders?token=${window.customerToken}

Template file: orders.html

Schema: '{ "orders": { "status": "SUCCESS", "sort_by": "shipped_date-desc" }, "customer": {}, "settings": {}, "store": {} }'

Available template objects:

[GET] - Retrieve an order

GET /request_objects

(async () => {
  let schema = '{ "orders": { "id": <int:order_id> }, "customer": {}, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "orders": { "id": <int:order_id> }, "customer": {}, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "orders": { "id": <int:order_id> }, "customer": {}, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"John@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":3,
      "number_subscriptions":14,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-04-30T15:11:43"
   },
   "orders":{
      "address_id":7976732,
      "address_is_active": 1,
      "billing_address":{
         "address1":"101 Washington Street",
         "address2":"204",
         "city":"los angeles",
         "company":"bootstrap",
         "country":"United States",
         "first_name":"John",
         "last_name":"Doe",
         "phone":"5553103101",
         "province":"California",
         "zip":"90025"
      },
      "browser_ip": null,
      "charge_id":42723497,
      "charge_status":"SUCCESS",
      "created_at":"2018-02-21T11:46:02",
      "currency": "USD",
      "customer": {
         "accepts_marketing": false,
         "email": "john.Doe@gmail.com",
         "first_name": "John",
         "last_name": "Doe",
         "phone": null,
         "send_email_welcome": false,
         "verified_email": true
      }
      "customer_id":8187626,
      "discount_codes":[
         "amount": "10.00",
         "code": "summerDiscount",
         "type": "percentage"
      ],
      "email":"john.doe@test.com",
      "error": "",
      "first_name":"John",
      "hash":"818762670d14f56b6f39fd7",
      "id":31541603,
      "include": {
         "order_modifications": []
      },
      "is_prepaid":0,
      "last_name":"Doe",
      "line_items":[
         {
            "external_inventory_policy": "bypass",
            "grams":907,
            "images":{
               "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_large.jpg",
               "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_medium.jpg",
               "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep.jpg",
               "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_small.jpg"
            },
            "price":12.99,
            "product_title":"Bare Sleep",
            "properties":[

            ],
            "quantity":1,
            "shopify_product_id":"505545949248",
            "shopify_variant_id":"5421270171712",
            "sku":"12347",
            "subscription_id":11959568,
            "tax_lines": [],
            "title":"Bare Sleep",
            "variant_title":""
         },
         {
            "external_inventory_policy": "bypass",
            "grams":907,
            "images":{
               "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_large.jpg",
               "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_medium.jpg",
               "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep.jpg",
               "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/sleep_small.jpg"
            },
            "price":10.39,
            "product_title":"Bare Sleep  20.00% Off Auto renew",
            "properties":[
               {
                  "name":"shipping_interval_frequency",
                  "value":"1"
               },
               {
                  "name":"shipping_interval_unit_type",
                  "value":"Months"
               }
            ],
            "quantity":2,
            "shopify_product_id":"505545949248",
            "shopify_variant_id":"5421270171712",
            "sku":"12347",
            "subscription_id":11959568,
            "tax_lines": [],
            "title":"Bare Sleep  20.00% Off Auto renew (Ships every 1 Months)",
            "variant_title":""
         }
      ],
      "note":null,
      "note_attributes":[

      ],
      "payment_processor": "stripe",
      "processed_at":"2018-02-21T11:46:02",
      "scheduled_at":"2018-02-21T00:00:00",
      "shipped_date": "2018-06-01T09:38:21",
      "shipping_address":{
         "address1":"101 Washington Street",
         "address2":"204",
         "city":"los angeles",
         "company":"bootstrap",
         "country":"United States",
         "first_name":"John",
         "last_name":"Doe",
         "phone":"5553103101",
         "province":"California",
         "zip":"90025"
      },
      "shipping_date": "2018-12-26T00:00:00",
      "shipping_lines":[
         {
            "code":"Priority",
            "description":null,
            "price":"7.80",
            "source":"Subscription",
            "tax_lines":"[]",
            "title":"Priority Mail"
         }
      ],
      "shopify_cart_token":"02a2d4408ce577f8d0362791fb42ba2e",
      "shopify_customer_id": "123227119987",
      "shopify_id": "1233312321323",
      "shopify_order_id":"363227119680",
      "shopify_order_number":1002,
      "status":"SUCCESS",
      "subtotal_price":"33.77",
      "tags":"Subscription, Subscription First Order",
      "tax_lines":[

      ],
      "total_discounts":null,
      "total_line_items_price":null,
      "total_price":"41.57",
      "total_refunds":null,
      "total_tax":0.0,
      "total_weight":2721,
      "transaction_id":"ch_1By0jCJ2zqHvZRd1OOT2qHOx",
      "type":"CHECKOUT",
      "updated_at":"2018-02-21T12:46:02"
   },
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with order details for the current order.

URL: {{ order_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/orders/<int:order_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/orders/<int:order_id>?token=${window.customerToken}

Template file: order.html

Schema: '{ "orders": { "id": <int:order_id> }, "customer": {}, "settings":{}, "store": {} }'

Available template objects

[POST] - Delay prepaid order

(async () => {
  const url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/orders/839203/delay?token=${window.customerToken}`;

  try {
    const response = await axios.post(url);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

const url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/orders/839203/delay?token=${window.customerToken}`;
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  },
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/orders/839203/delay?token=${window.customerToken}`,
  type: 'post',
  dataType: 'json'
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

This endpoint will delay a prepaid order by one interval.


URL: /orders/<int:order_id>/delay

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/orders/<int:order_id>/delay?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/orders/<int:order_id>/delay?token=${window.customerToken}

Payment methods

Payment Methods hold payment and billing information for a customer. As of the API version 2021-11, a Customer may be associated with many Payment Methods, and an Address record must be associated with at least one Payment Method. This definition of payment instruments as Payment Method for customers supercedes Payment Sources.

Payment methods routes


GET /tools/recurring/portal/<string:customer_hash>/payment_methods

This endpoint renders a template with the a customer's list of billing information. route details

GET /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>

This endpoint renders the billing information details for a specific Payment Method for the customer. route details

POST /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>

This endpoint updates a specific payment method. route details

GET /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>/billing_address?token=${window.customerToken}

This endpoint updates customer's billing address information. route details

GET /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>/card?token=${window.customerToken}

This endpoint renders a template with a card form to update the payment token securely. route details

Payment Method object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
payment_method.billing_address
array		 "address1": "101 Washington Street"
"address2": ""
"city": "Los Angeles"
"company": "Recharge"
"country": "United States"
"country_code": "US"
"first_name": "John"
"last_name": "Doe"
"phone": "5551231234"
"province": "California"
"zip": "90024"

Returns billing address information.
  • [string] address1: The street address of the billing address.
  • [string] address2: An optional additional field for the street address of the billing address.
  • [string] city: The city of the billing address.
  • [string] company: The company of the person associated with the billing address.
  • [string] country: The name of the country of the billing address.
  • [string] country_code: The code of the coutry of the billing address.
  • [string] first_name: The first name of the person associated with the payment method.
  • [string] last_name: The last name of the person associated with the payment method.
  • [string] phone: The phone number associated with the billing address.
  • [string] province: The name of the state or province of the billing address.
  • [string] zip: The zip or postal code of the billing address.
payment_method.created_at
string		 "payment_method.created_at": "2021-11-02T09:32:54"
Timestamp of creation of the payment method.
payment_method.customer_id
number		 "payment_method.customer_id": 8187626
Unique customer identifier.
payment_method.default
boolean		 "payment_method.default": true
If true, this is the default payment_method for a customer.
payment_method.id
number		 "payment_method.id": 12345675
Unique payment method id.
payment_method.payment_details
object		 "brand": "visa"
"exp_month": "03"
"exp_year": "2025"
"last4": "1235"

Returns the details of the payment method. Details may differ depending on payment_type of the Payment Method.
  • [string] brand: Brand or Company providing the payment instrument.
  • [int] exp_month: Expiry month.
  • [int] exp_year: Expiry year.
  • [string] last4: last 4-digits of the identifier.
  • [string] paypal_email: email linked to the Paypal account.
  • [string] paypal_payer_id: Paypal user identifier.
  • [string] wallet_type: Type/Brand of the digital wallet.
  • [string] funding_type: Type of funding for the Payment Mthod.
payment_method.payment_type
string		 "payment_method.payment_type": "credit_card"
Identifies the type of instrument used for the payment method.
payment_method.processor_customer_token
string		 "payment_method.processor_customer_token": "cus_AB3ebcBaL6pCx9"
The customer token at the processor.
payment_method.processor_name
string		 "payment_method.processor_name": "stripe"
the name of the payment processor used for this payment method.
payment_method.processor_payment_method_token
string		 "payment_method.processor_payment_method_token": "pm_1MEuCq4kseIcOIxKb8OwVq7V"
The payment token at the processor.
payment_method.status
string		 "payment_method.status": "failed"
It identifies status of payment method. It can have not_validated, valid or invalid.
payment_method.status_reason
string		 "payment_method.status_reason": "no_payment_method"
It identifies payment processor. It can have stripe, braintree or authorize value.
payment_method.subscriptions
array		 "payment_method.subscriptions": []
Identifies the subscriptions this payment method funds.
payment_method.updated_at
string		 "payment_method.updated_at": "2021-11-02T09:32:54"
Timestamp for last update performed on the Payment Method.

[GET] - List of payment methods

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_methods": [], "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_methods": [], "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_methods": [], "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-08T10:22:17"
   },
   "payment_methods":[  
      {  
         "billing_address":{  
            "address1":"101 Washington Street",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "country_code": "US",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5551231234",
            "province":"California",
            "zip":"90024"
         },
         "created_at": "2021-11-14T09:00:01",
         "customer_id":8187626,
         "default": true,
         "id": 1234567,
         "payment_details" : [
             {
                 "brand" : "visa",
                 "exp_month" : 04
                 "exp_year" : 2025,
                 "last4": 1235
             }
         ],
         "payment_type": "credit_card",
         "processor_customer_token":"cus_AB3ebcBaL6pCx9",
         "processor_name":"stripe",
         "processor_payment_token":"pm_123123",
         "subscriptions": [],
         "updated_at": "2021-12-14T09:00:01",,
      },
      {  
         "billing_address":{  
            "address1":"101 Washington Street",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "country_code": "US",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5551231234",
            "province":"California",
            "zip":"90024"
         },
         "created_at": "2021-11-14T09:00:01",
         "customer_id":8187626,
         "default": false,
         "id": 1234589,
         "payment_details" : [
             {
                 "brand" : "mastercard",
                 "exp_month" : 11
                 "exp_year" : 2040,
                 "last4": 1546
             }
         ],
         "payment_type": "credit_card",
         "processor_customer_token":"cus_AB3ebcBaL6pCx9",
         "processor_name":"stripe",
         "processor_payment_token":"pm_485523123",
         "subscriptions": [],
         "updated_at": "2021-12-14T09:00:01",,
      }
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a customer's specific payment method and their details.

URL: {{ payment_methods_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_methods?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_methods?token=${window.customerToken}

Template file: payment_methods.html

Schema: '{ "customer": {}, "payment_methods": [], "store": {} }'

Available template objects:

[GET] - Retrieve a Payment Method

This endpoint renders a json object with the details of a payment method.

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
    "payment_methods": {
        "billing_address":{  
            "address1":"101 Washington Street",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "country_code": "US",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5551231234",
            "province":"California",
            "zip":"90024"
            },
        "created_at": "2021-11-14T09:00:01",
        "customer_id":8187626,
        "default": true,
        "id": 1234567,
        "payment_details" : [
            {
                "brand" : "visa",
                "exp_month" : 04
                "exp_year" : 2025,
                "last4": 1235
            }
        ],
        "payment_type": "credit_card",
        "processor_customer_token":"cus_AB3ebcBaL6pCx9",
        "processor_name":"stripe",
        "processor_payment_token":"pm_123123",
        "updated_at": "2021-12-14T09:00:01"
    }
}

This endpoint renders a json object with the details of a single payment method of the customer.

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_methods/<int:payment_method_id>?token=${window.customerToken}

Available template objects:

[POST] - Update a Payment Method

POST /payment_methods/<int:payment_method_id>

(async () => {
  let url = '{{ payment_method_url }}';
  let data = {
    "billing_address1":"101 Washington Street",
    "billing_address2":"",
    "billing_city":"Los Angeles",
    "billing_company":"Recharge",
    "billing_country":"United States",
    "billing_first_name":"John",
    "billing_last_name":"Doe",
    "billing_phone":"5551231234",
    "billing_province":"California",
    "billing_zip":"90024"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ payment_method_url }}';
let data = {
  "billing_address1":"101 Washington Street",
  "billing_address2":"",
  "billing_city":"Los Angeles",
  "billing_company":"Recharge",
  "billing_country":"United States",
  "billing_first_name":"John",
  "billing_last_name":"Doe",
  "billing_phone":"5551231234",
  "billing_province":"California",
  "billing_zip":"90024"
}
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ payment_method_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    "billing_address1":"101 Washington Street",
    "billing_address2":"",
    "billing_city":"Los Angeles",
    "billing_company":"Recharge",
    "billing_country":"United States",
    "billing_first_name":"John",
    "billing_last_name":"Doe",
    "billing_phone":"5551231234",
    "billing_province":"California",
    "billing_zip":"90024"
  }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      }, 
      "billing_address1":"101 Washington Street",
      "billing_address2":"",
      "billing_city":"Los Angeles",
      "billing_company":"Recharge",
      "billing_country":"United States",
      "billing_phone":"5551231234",
      "billing_province":"California",
      "billing_zip":"90024",
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "has_valid_payment_method":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "processor_type":null,
      "reason_payment_method_not_valid":"NO_PAYMENT_METHOD",
      "shopify_customer_id":"391100760128",
      "status":"ACTIVE",
      "updated_at":"2019-05-13T13:05:29"
   }
}

This endpoint updates customer's billing address information.

URL: {{ payment_source_address_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_source/1/address?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_source/1/address?token=${window.customerToken}

Template file: payment_source_address.html

Available template objects:

Arguments accepted:

Property Type
billing_address1 * string
billing_address2 string
billing_city * string
billing_company string
billing_country * string
billing_first_name * string
billing_last_name * string
billing_phone * string
billing_province * string
billing_zip * string

* = required

[GET] - Retrieve a form to update a payment method billing address details

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_methods": { "payment_method_id": <int:payment_method_id> }, "billing_countries": [], "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_methods": { "payment_method_id": <int:payment_method_id> }, "billing_countries": [], "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_methods": { "payment_method_id": <int:payment_method_id> }, "billing_countries": [], "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-08T10:22:17"
   },
   "payment_methods":[  
        {   
            "billing_address":{  
                "address1":"101 Washington Street",
                "address2":"",
                "city":"Los Angeles",
                "company":"Recharge",
                "country":"United States",
                "country_code": "US",
                "first_name":"John",
                "last_name":"Doe",
                "phone":"5551231234",
                "province":"California",
                "zip":"90024"
            },
            "created_at": "2021-11-14T09:00:01",
            "customer_id":8187626,
            "default": true,
            "id": 1234567,
            "payment_details" : [
                {
                    "brand" : "visa",
                    "exp_month" : 04
                    "exp_year" : 2025,
                    "last4": 1235
                }
            ],
            "payment_type": "credit_card",
            "processor_customer_token":"cus_AB3ebcBaL6pCx9",
            "processor_name":"stripe",
            "processor_payment_token":"pm_123123",
            "updated_at": "2021-12-14T09:00:01",,
        }
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a form for updating the billing address for the customer customer.

URL: {{ payment_methods_billing_address_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>/billing_address?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_methods/<int:payment_method_id>/billing_address?token=${window.customerToken}

Template file: edit_payment_method_address.html

Schema: '{ "customer": {}, "payment_methods": { "payment_method_id": <int:payment_method_id> }, "settings": {}, "store": {} }'

Available template objects:

[GET] - Retrieve a form to update payment method details

This endpoint renders a template with a form for updating payment details for the customer.

This endpoint is special because we do not allow the customization of the credit card form, only allow an embedded iFrame. You’ll need to use CSS to style the containing window. You can provide CSS in the Credit Card CSS editor in the Settings > Customer Portal settings area.

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
    "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-08T10:22:17"
   },
    "payment_methods":[  
            {  
                "billing_address":{  
                    "address1":"101 Washington Street",
                    "address2":"",
                    "city":"Los Angeles",
                    "company":"Recharge",
                    "country":"United States",
                    "country_code": "US",
                    "first_name":"John",
                    "last_name":"Doe",
                    "phone":"5551231234",
                    "province":"California",
                    "zip":"90024"
                },
                "created_at": "2021-11-14T09:00:01",
                "customer_id":8187626,
                "default": true,
                "id": 1234567,
                "payment_details" : [
                    {
                        "brand" : "visa",
                        "exp_month" : 04
                        "exp_year" : 2025,
                        "last4": 1235
                    }
                ],
                "payment_type": "credit_card",
                "processor_customer_token":"cus_AB3ebcBaL6pCx9",
                "processor_name":"stripe",
                "processor_payment_token":"pm_123123",
                "subscriptions": [],
                "updated_at": "2021-12-14T09:00:01"
            }
    ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a form for updating payment details for the customer.

URL: {{ payment_methods_edit_card_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_methods/<int:payment_method_id>/card?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_methods/<int:payment_method_id>/card?token=${window.customerToken}

Template file: edit_payment_method.html

Schema: '{ "customer": {}, "payment_methods": { "id": <int:payment_method_id> }, "settings": {}, "store": {} }'

Available template objects:

Payment sources

Retrieve payment sources for a customer. Payment sources include billing address and credit card informations.

Payment sources routes


GET /tools/recurring/portal/<string:customer_hash>/payment_sources

This endpoint renders a template with a customer's billing information. route details

GET /tools/recurring/portal/<string:customer_hash>/payment_source

This endpoint renders a template with a form for updating payment details for the customer. route details

GET /tools/recurring/portal/<string:customer_hash>/payment_source/1/address

This endpoint renders a template with a form for updating billing address for the customer customer. route details

POST /tools/recurring/portal/<string:customer_hash>/payment_source/1/address

This endpoint updates customer's billing address information. route details

Payment sources object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
payment_source.billing_address
"address1": "101 Washington Street"
"address2": ""
"city": "Los Angeles"
"company": "Recharge"
"country": "United States"
"first_name": "John"
"last_name": "Doe"
"phone": "5551231234"
"province": "California"
"zip": "90024"

Returns billing address information.
  • [string] address1: The street address of the billing address.
  • [string] address2: An optional additional field for the street address of the billing address.
  • [string] city: The city of the billing address.
  • [string] company: The company of the person associated with the billing address.
  • [string] country: The name of the country of the billing address.
  • [string] first_name: The first name of the person associated with the payment method.
  • [string] last_name: The last name of the person associated with the payment method.
  • [string] phone: The phone number associated with the billing address.
  • [string] province: The name of the state or province of the billing address.
  • [string] zip:The zip or postal code of the billing address.
payment_source.card_brand
string		 "payment_source.card_brand": "visa"
It identifies the brand of credit card.
payment_source.card_exp_month
number		 "payment_source.card_exp_month": 9
The month when card expires.
payment_source.card_exp_year
number		 "payment_source.card_exp_year": 2020
The year when card expires.
payment_source.card_last4
string		 "payment_source.card_last4": 4242
The last four digits of card.
payment_source.cardholder_name
string		 "payment_source.cardholder_name": Recharge Test
Card owner name information.
payment_source.customer_id
number		 "payment_source.customer_id": 8187626
Unique customer identifier.
payment_source.has_card_error_in_dunning
boolean		 "payment_source.has_card_error_in_dunning": false
If it has true value, then there was an error in dunning process. There was not error in dunning process if it has false value.
payment_source.id
number		 "payment_source.id": "1"
Payment source unique numeric identifier
payment_source.payment_token
string		 "payment_source.payment_token": "1"
Payment source unique token.
payment_source.payment_type
string		 "payment_source.payment_type": "credit"
It identifies the payment type. It can have credit, debit, paypal or apple_pay values.
payment_source.processor_name
string		 "payment_source.processor_name": "stripe"
It identifies payment processor. It can have stripe, braintree or authorize value.
payment_source.status
string		 "payment_source.status": "failed"
It identifies status of payment method. It can have active or failed value.
payment_source.status_reason
string		 "payment_source.status_reason": "NO_PAYMENT_METHOD"
It provides more information why payment method is not valid if status has failed value.

[GET] - List of payment sources

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_sources": [], "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_sources": [], "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_sources": [], "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-08T10:22:17"
   },
   "payment_sources":[  
      {  
         "billing_address":{  
            "address1":"101 Washington Street",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5551231234",
            "province":"California",
            "zip":"90024"
         },
         "card_brand":'visa',
         "card_exp_month":10,
         "card_exp_year":2022,
         "card_last4":4242,
         "cardholder_name": "Recharge Test",
         "customer_id":8187626,
         "has_card_error_in_dunning":false,
         "id": 1,
         "payment_token": null,
         "payment_type":"credit",
         "processor_name":"stripe",
         "status":"failed",
         "status_reason":"NO_PAYMENT_METHOD"
      }
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a customer's billing information.

URL: {{ payment_source_list_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_sources?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_sources?token=${window.customerToken}

Template file: payment_sources.html

Schema: '{ "customer": {}, "payment_sources": [], "store": {} }'

Available template objects:

[GET] - Retrieve a form to update credit card details

This endpoint renders a template with a form for updating payment details for the customer.

This endpoint is special because we do not allow the customization of the credit card form, only allow an embedded iFrame. You’ll need to use CSS to style the containing window. You can provide CSS in the Credit Card CSS editor in the Settings > Customer Portal settings area.

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-08T10:22:17"
   },
   "payment_sources":[  
      {  
         "billing_address":{  
            "address1":"101 Washington Street",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5551231234",
            "province":"California",
            "zip":"90024"
         },
         "card_brand":'visa',
         "card_exp_month":10,
         "card_exp_year":2022,
         "card_last4":4242,
         "cardholder_name": "Recharge Test",
         "customer_id":8187626,
         "has_card_error_in_dunning":false,
         "id": 1,
         "payment_token": null,
         "payment_type":"credit",
         "processor_name":"stripe",
         "status":"failed",
         "status_reason":"NO_PAYMENT_METHOD"
      }
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a form for updating payment details for the customer.

URL: {{ payment_source_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_source?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_source?token=${window.customerToken}

Template file: payment_source.html

Schema: '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "settings": {}, "store": {} }'

Available template objects:

[GET] - Retrieve a form to update billing address details

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "billing_countries": [], "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "billing_countries": [], "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "billing_countries": [], "settings": {}, "store": {} }' }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-08T10:22:17"
   },
   "payment_sources":[  
      {  
         "billing_address":{  
            "address1":"101 Washington Street",
            "address2":"",
            "city":"Los Angeles",
            "company":"Recharge",
            "country":"United States",
            "first_name":"John",
            "last_name":"Doe",
            "phone":"5551231234",
            "province":"California",
            "zip":"90024"
         },
         "card_brand":'visa',
         "card_exp_month":10,
         "card_exp_year":2022,
         "card_last4":4242,
         "cardholder_name": "Recharge Test",
         "customer_id":8187626,
         "has_card_error_in_dunning":false,
         "id": 1,
         "payment_token": null,
         "payment_type":"credit",
         "processor_name":"stripe",
         "status":"failed",
         "status_reason":"NO_PAYMENT_METHOD"
      }
   ]
   "billing_countries":[  
      {  
         "code":"AF",
         "country_id":1,
         "id":null,
         "name":"Afghanistan",
         "provinces":[  

         ]
      },
      {  
         "code":"AR",
         "country_id":9,
         "id":null,
         "name":"Argentina",
         "provinces":[  
            {  
               "code":"B",
               "id":1964,
               "name":"Buenos Aires"
            },
            {  
               "code":"C",
               "id":1970,
               "name":"Buenos Aires City"
            }
            ...
         ]
      },
      ...
   ],
   "settings":{
      "customer_portal":{
         "custom_code":{
            "footer": "",
            "header": "",
            "header_logo_url": "",
         },
         "discount_input":true,
         "edit_shipping_address":true,
         "hosted_customer_portal":true,
         "inventory_behaviour":"bypass",
         "onetime":{
            "available_products":"recharge_products",
            "enabled":true,
            "shopify_collection_id":null,
            "zero_inventory_purchase":true
         },
         "subscription":{
            "add_product":true,
            "cancel_subscription":true,
            "cancellation_email_contact":"",
            "cancellation_minimum_order_count":0,
            "change_product":true,
            "change_quantity":true,
            "change_variant":true,
            "edit_order_frequency":"Any",
            "edit_scheduled_date":true,
            "reactivate_subscription":true,
            "skip_scheduled_order":true,
            "zero_inventory_purchase":true
         },
         "view_order_schedule":true,
         "view_recharge_payment_methods": false
      },
      "has_shopify_connector": false,
      "shop_id":41575
   },
   "store": {
      "checkout_logo_url": "",
      "checkout_platform": "recharge",
      "created_at": "Wed, 25 Dec 2019 13:16:44 GMT",
      "currency": "USD",
      "customer_portal_domain": "",
      "domain": "store.myshopify.com",
      "email": "johndoe@gmail.com",
      "external_platform": "shopify",
      "iana_timezone": "America/New_York",
      "id": 90732,
      "migrated_to_shopify_checkout_integration": 0,
      "my_shopify_domain": "store.myshopify.com",
      "name": "mystore",
      "platform_domain": "store.myshopify.com",
      "shop_email": "johndoe@gmail.com",
      "shop_phone": "",
      "timezone": "(GMT-05:00) America/New_York",
      "updated_at": "Thu, 17 Sep 2020 03:06:52 GMT"
   }
}

This endpoint renders a template with a form for updating billing address for the customer customer.

URL: {{ payment_source_address_url }}

Methods accepted: GET

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_source/1/address?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_source/1/address?token=${window.customerToken}

Template file: payment_source_address.html

Schema: '{ "customer": {}, "payment_sources": { "customer_id": <int:customer.id> }, "billing_countries": [], "settings": {}, "store": {} }'

Available template objects:

[POST] - Update billing address details

POST /payment_source/1/address

(async () => {
  let url = '{{ payment_source_address_url }}';
  let data = {
    "billing_address1":"101 Washington Street",
    "billing_address2":"",
    "billing_city":"Los Angeles",
    "billing_company":"Recharge",
    "billing_country":"United States",
    "billing_first_name":"John",
    "billing_last_name":"Doe",
    "billing_phone":"5551231234",
    "billing_province":"California",
    "billing_zip":"90024"
  }

  try {
    const response = await axios.post(url, data);
    // Successful request made
    console.log(response.data);           
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let url = '{{ payment_source_address_url }}';
let data = {
  "billing_address1":"101 Washington Street",
  "billing_address2":"",
  "billing_city":"Los Angeles",
  "billing_company":"Recharge",
  "billing_country":"United States",
  "billing_first_name":"John",
  "billing_last_name":"Doe",
  "billing_phone":"5551231234",
  "billing_province":"California",
  "billing_zip":"90024"
}
let options = {
  method: "post",  
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(data)
}

fetch(url, options)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ payment_source_address_url }}',
  type: 'post',
  dataType: 'json',
  data: {
    "billing_address1":"101 Washington Street",
    "billing_address2":"",
    "billing_city":"Los Angeles",
    "billing_company":"Recharge",
    "billing_country":"United States",
    "billing_first_name":"John",
    "billing_last_name":"Doe",
    "billing_phone":"5551231234",
    "billing_province":"California",
    "billing_zip":"90024"
  }
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      }, 
      "billing_address1":"101 Washington Street",
      "billing_address2":"",
      "billing_city":"Los Angeles",
      "billing_company":"Recharge",
      "billing_country":"United States",
      "billing_phone":"5551231234",
      "billing_province":"California",
      "billing_zip":"90024",
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "has_valid_payment_method":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "last_name":"Doe",
      "number_active_subscriptions":8,
      "number_subscriptions":19,
      "processor_type":null,
      "reason_payment_method_not_valid":"NO_PAYMENT_METHOD",
      "shopify_customer_id":"391100760128",
      "status":"ACTIVE",
      "updated_at":"2019-05-13T13:05:29"
   }
}

This endpoint updates customer's billing address information.

URL: {{ payment_source_address_url }}

Methods accepted: POST

Embedded Route: /tools/recurring/portal/<string:customer_hash>/payment_source/1/address?token=${window.customerToken}

Hosted Route: /portal/<string:customer_hash>/payment_source/1/address?token=${window.customerToken}

Template file: payment_source_address.html

Available template objects:

Arguments accepted:

Property Type
billing_address1 * string
billing_address2 string
billing_city * string
billing_company string
billing_country * string
billing_first_name * string
billing_last_name * string
billing_phone * string
billing_province * string
billing_zip * string

* = required

Billing Country object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
billing_country.code
string		 "billing_country.code": "AU"
The code of the billing country.
billing_country.country_id
number		 "billing_country.country_id": 12
Id of the billing country.
billing_country.id
string		 "billing_country.id": "null"
Id of the billing country.
billing_country.name
string		 "billing_country.name": "Australia"
Name of the billing country.
billing_country.province_label
string		 "billing_country.province_label": "State/territory"
Province type label.
billing_country.provinces
array of objects		 "billing_country.provinces": [
"code": "ACT",
"id": 2289,
"name": "Australian Capital Territory"
]

Country provinces.
billing_country.zip_label
string		 "billing_country.zip_label": "Postcode"
Zip type label.
billing_country.zip_required
boolean		 "billing_country.zip_required": true
Indicates whether the zip is required.

Products

EXAMPLE USING PROPERTIES

{% if product.discount_amount %}
    {% if product.discount_type == 'percentage' %}
      {% set product_price = product_price | float %}
      {% set calculate_discounted = product_price * (1 - product.discount_amount / 100) %}
      {{ calculate_discounted | money }}
    {% else %}
      {{ product_price - product.discount_amount | money }}
    {% endif %}
{% else %}
    {{ product_price | money }}
{% endif %}

EXAMPLE OUTPUT

$70.00

Products are used during the Add Product or Swap Product flow. Consider product a template for which a customer uses to create a subscription from or swap a product in a subscription. A set of products, including subscription type and variants, and price.

Search for products

Page that returns a list of all products available to be subscribed to.

Product routes

Routes are used to retrieve data. Some routes are tied to templates, which can be rendered by the theme engine. All routes have an accepted method. View route details for more information.


GET /tools/recurring/portal/<string:customer_hash>/products/search

This endpoint renders a template with a list of all products available cusomter could be subscribed to. route details

Product object

Object contains the different variables of information you may want to access when rendering an object.

Property Definition
product.collection_id
number		 "product.collection_id":106920
Unique numeric identifier for the ruleset created in Recharge.
product.collection_ids
array		 "product.collection_ids": []
Array of collection ids.
product.created_at
string		 "product.created_at":"2018-02-16T11:05:55"
Date and time when ruleset is created.
product.discount_amount
number		 "product.discount_amount":0
Discount amount applied on ruleset.
product.discount_type
string		 "product.discount_type":"percentage"
The type of discount. Either percentage or fixed_amount.
product.handle
string		 "product.handle":"bare-box-3-month-plan"
Handle value for product in Shopify. Used in product edit page.
product.id
number		 "product.id":659929
Unique numeric identifier of the product in Recharge.
product.images
object		 "large": "https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db_large.jpg"
"medium": "https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db_medium.jpg"
"original": "https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db.jpg"
"small": "https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db_small.jpg"

Returns images of the product.
product.inventory_policy
object		 "one_time": "1"
"subscription": "1"

Returns inventory policy of the product.
product.shopify_details
object		 "body_html": Perfect for hot weather. If you want to cool yourself and find some peace, then Brain freeze is the perfect choice.
"created_at": "2019-07-09T10:25:17"
"handle": "brain-freeze"
"image": {
"alt": null
"created_at": "2019-07-09T10:25:17"
"height": 720
"position": 1
"shopify_id": 1234567890
"shopify_product_id": 1999358560003
"shopify_variant_ids": []
"src": ""https://cdn.shopify.com/s/files/1/0092/3765/9699/products/1_f4b108dbf.jpg?v=1563684188""
"updated_at": "2019-07-09T10:23:08-04:00"
"width": 1280
}
"images": [
"alt": null
"created_at": "2019-07-09T10:25:17"
"height": 720
"position": 1
"shopify_id": 1234567890
"shopify_product_id": 1999358560003
"shopify_variant_ids": []
"src": "https://cdn.shopify.com/s/files/1/0092/3765/9699/products/1_f4b108dbf.jpg?v=1563684188"
"updated_at": "2019-07-09T10:23:08-04:00"
"width": 1280
]
"options": [
"name": "Title"
"position": 1
"shopify_id": 123456789
"shopify_product_id": 9876543210
"values": [
"Default Title"
]
]
"product_type": ""
"published_at": "2019-07-09T10:18:32-04:00"
"shopify_id": 9876543210
"tags": ""
"title": "Brain freeze"
"updated_at": "2019-08-19T12:39:17-04:00"
"variants": [
"barcode": ""
"compare_at_price": null
"created_at": "2019-07-09T10:23:05-04:00"
"fulfillment_service": "manual"
"grams": 136
"image": {
"large": "https://cdn.shopify.com/s/files/1/0017/8929/6710/products/1_f4b108dbf.jpg?v=1669052924"
"medium": "https://cdn.shopify.com/s/files/1/0017/8929/6710/products/1_f4b108dbb.jpg?v=1669052924"
"original": "https://cdn.shopify.com/s/files/1/0017/8929/6710/products/1_f4b108fbf.jpg?v=1669052924"
"small": "https://cdn.shopify.com/s/files/1/0017/8929/6710/products/1_f4b108vff.jpg?v=1669052924"
"sort_order": 1
}
"inventory_management": "shopify"
"inventory_policy": "deny"
"inventory_quantity": 0
"option1": "Default Title"
"option2": null
"option3": null
"position": 1
"presentment_prices": [<br> {<br> "currency": "USD",<br> "discounted_price": "38.55",<br> "unit_price": "42.83"<br> },<br> {<br> "currency": "CAD",<br> "discounted_price": "9.89",<br> "unit_price": "10.99"<br> }<br> ]
"price": "5.00"
"requires_shipping": true
"shopify_id": 17917730424832
"shopify_image_id": null
"shopify_product_id": 1999358580003
"sku": "004"
"taxable": true
"title": "Default Title"
"updated_at": "2019-08-19T12:39:17-04:00"
"weight": 0.3
"weight_unit": "lb"
]
"vendor": "Test Store"


We have modified the shopify_details object that gets returned in an effort to reduce confusion with Recharge IDs. We have modified the following properties found within the object:
- id == shopify_id
- product_id == shopify_product_id
- variant_ids = shopify_variant_ids
product.shopify_product_id
number		 "product.shopify_product_id":506020921408
Unique numeric identifier of the product in Shopify.
product.subscription_defaults
object		 "charge_interval_frequency": 2
"cutoff_day_of_month": null
"cutoff_day_of_week": null
"expire_after_specific_number_of_charges": null
"modifiable_properties": []
"number_charges_until_expiration": null
"order_day_of_month": null
"order_day_of_week": null
"order_interval_frequency_options": ["2", "1"]
"order_interval_unit": "Weeks"
"storefront_purchase_options": "subscription_and_onetime"

Returns default attributes for the Subscription.
product.title
string		 "product.title":"Bare Box - 3 Month Plan"
The title of the product.
product.updated_at
string		 "product.updated_at":"2019-03-13T16:37:33"
Date and time when ruleset is updated.

[GET] - List of products

Returns a list of all products available.

GET /request_objects

(async () => {
  let schema = '{ "customer": {}, "products": { "base_source": "store_settings", "page": 1, "limit": 15 }, "products_count": { "base_source": "store_settings" }, "settings": {}, "store": {} }';
  let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;
  try {
    const response = await axios(url);
    // Successful request made
    console.log(response.data);         
  } catch (error) {
    // Request failed
    console.error(error);
  }
})();

let schema = '{ "customer": {}, "products": { "base_source": "store_settings", "page": 1, "limit": 15 }, "products_count": { "base_source": "store_settings" }, "settings": {}, "store": {} }';
let url = `{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects?token=${window.customerToken}&schema=${schema}`;

fetch(url)
  .then((response) => response.json())
  .then((showData) => {
    // Successful request made
    console.log(showData);
  })
  .catch((error) => {
    // Request failed
    console.error(error);
  });

$.ajax({
  url: '{{ shopify_proxy_url if proxy_redirect else "" }}/portal/{{ customer.hash }}/request_objects' + '?token=' + window.customerToken,
  type: 'get',
  dataType: 'json',
  data: { schema: '{ "customer": {}, "products": { "base_source": "store_settings", "page": 1, "limit": 15 }, "products_count": { "base_source": "store_settings" }, "settings": {}, "store": {} }'}
}).done(function(response) {
  // Successful request made
  console.log(response);
}).fail(function(response) {
  // Request failed
  console.log(response);
});

CLICK HERE TO SEE RESPONSE

{  
   "customer":{  
      "accepts_marketing": null,
      "analytics_data": {
         "utm_params": []
      },  
      "can_add_payment_method": false,
      "created_at":"2018-02-21T11:45:58",
      "email":"john.doe@test.com",
      "first_charge_processed_at":"2018-02-21T11:46:02",
      "first_name":"John",
      "has_card_error_in_dunning":false,
      "hash":"818762670d14f56b6f39fd7",
      "id":8187626,
      "include": {
         "payment_methods": []
      },
      "last_name":"Doe",
      "number_active_subscriptions":7,
      "number_subscriptions":19,
      "shopify_customer_id":"391100760128",
      "updated_at":"2019-05-17T19:54:30"
   },
   "products":[  
      {  
         "collection_id":106920,
         "collection_ids":[],
         "created_at":"2018-02-16T11:05:55",
         "discount_amount":0.0,
         "discount_type":"percentage",
         "handle":"bare-box-3-month-plan",
         "id":659929,
         "images":{  
            "large":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db_large.jpg",
            "medium":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db_medium.jpg",
            "original":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db.jpg",
            "small":"https://cdn.shopify.com/s/files/1/3104/4618/products/surprise-box_7facd505-3d76-4ce9-8f33-99146e2fd4db_small.jpg"
         },
         "inventory_policy":{  
            "one_time":"1",