Recurly Shipping Fees API
The shipping-fees API from Recurly — 2 operation(s) for shipping-fees.
The shipping-fees API from Recurly — 2 operation(s) for shipping-fees.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/recurly:recurly-shipping-fees-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Recurly V2 Shipping Fees API
description: '# Getting Started
Welcome to the reference documentation for Recurly''s XML API v2. Here you will find a complete
reference for all API v2 operations. If you''re building a new product, or just getting started with Recurly, we recommend
using our newer JSON API v3. Now let''s get started with API v2. # Authentication
##### API Authentication (HTTP Basic)
Recurly uses HTTP Basic Authentication—your Private API key is securely encrypted by the SSL channel. If you are testing the API calls via the command line with cURL, try:
```
curl -H ''Accept: application/xml'' \
-H ''X-Api-Version: 2.29'' \
-H ''Content-Type: application/xml; charset=utf-8'' \
-u ''[apikey]'' \
https://[subdomain].recurly.com/v2/accounts
```
Replace `[apikey]` and `[subdomain]` with the appropriate values for your site. ##### Calculating your own authorization header
Most programming languages encode the authorization header automatically. With HTTP Basic Authentication, the `Authorization` header is a string containing a Base-64 encoded username and password. In the case of Recurly''s API, you need only specify the username as your API key. If your library requires a password, set it to an empty string. ```
"Authorization": "Basic " + base64_encode(API Key)
```
##### Additional Request Headers
**Accept Header**
Recurly API v2 returns results as XML. Your requests should always include the header requesting the results as XML:
```
Accept: application/xml
```
**Content-Type Header**
When sending data to Recurly in a POST or PUT request, your request must specify the content type of your request:
```
Content-Type: application/xml; charset=utf-8
```
**X-Api-Version Header**
When sending data to Recurly, your request should specify the API version you''re attempting to interact with:
```
X-Api-Version: 2.29
```
You learn more about the different versions in the API Versioning section. ##### Public API Key
Recurly uses two types of API keys: public and private. The Public API key is used by Recurly.js to identify its requests as belonging to your Recurly site. This key can be safely included in Javascript code. Recurly provides each site with one Public Key. The Public API Key can be regenerated on the API Credentials page. ##### Private API Keys
###### Treat your Private API Keys like passwords! The API key allows access to your site''s data. Do not include it in Javascript code exposed to browsers. Recurly supports the use of multiple Private API keys, which can be used to integrate third party services using unique, controlled credentials. **Limits & Pricing**
Merchants on the Starter or grandfathered Recurly plans or merchants in sandbox mode will be granted 5 private API keys. Merchants on Recurly''s Professional plan will be granted 10 private API keys. **Default Key**
Your default private API key should be used to integrate Recurly with your backend systems. There will be at least one key active at all times. **Additional Keys**
Additional private API keys should be used to connect your Recurly data to additional sources, like analytics software, accounting packages, or email tools. Recurly recommends clearly labeling the name of each key to identify the associated vendor. **Regenerating Private API Keys**
Your API key can be regenerated by clicking on the Regenerate button on the API credentials page. When you generate a private API key, you have two options:
1. Block the old key immediately. This is primarily recommended when the security of a key has been compromised. 2. Allow the old key access for 12 hours. This is primarily used when updating systems and a smooth transition between keys is needed. *If a private API key is changed, an email alert will be sent to your Recurly Site Technical Contact.*
**Read-Only Keys**
When creating a private key, you will have the option to set the key to “read-only”. This means the API key may make GET requests but cannot not PUT, POST or DELETE requests.'
version: '2.29'
servers:
- url: https://{subdomain}.{domain}/v2
variables:
subdomain:
description: Subdomain of your Recurly site.
default: my-super-successful-company
domain:
description: Domain of your Recurly site.
default: recurly.com
security:
- api_key: []
tags:
- name: shipping-fees
x-displayName: Shipping Methods
paths:
/shipping_methods:
get:
summary: List Shipping Methods
description: For additional information regarding shipping methods, please see https://docs.recurly.com/docs/shipping
tags:
- shipping-fees
operationId: listShippingMethods
parameters:
- in: query
name: cursor
schema:
type: string
default: ''
description: Splits records across pages. Leave blank to return the first page. Follow the URI in the first page's Link header to fetch the next page.
- in: query
name: sort
schema:
type: string
default: created_at
description: 'The attribute that will be used to order records: `created_at`, `updated_at`.'
- in: query
name: order
schema:
type: string
default: desc
description: 'The order in which products will be returned: `asc` for ascending order, `desc` for descending order.'
- in: query
name: begin_time
schema:
type: string
format: date-time
default: ''
description: Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes greater than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
- in: query
name: end_time
schema:
type: string
format: date-time
default: ''
description: Operates on the attribute specified by the sort parameter. Filters records to only include those with datetimes less than or equal to the supplied datetime. Accepts an ISO 8601 date or date and time.
- in: query
name: per_page
schema:
type: integer
default: '50'
description: Number of records to return per page, up to a maximum of 200.
responses:
'200':
description: ''
content:
application/xml:
example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<shipping_methods type=\"array\">\n <shipping_method href=\"https://api.recurly.com/v2/shipping_methods/shipping\">\n <code>shipping</code>\n <name>Shipping</name>\n <accounting_code nil=\"nil\"></accounting_code>\n <tax_code nil=\"nil\"></tax_code>\n <liability_gl_account_id>t5ejtgf1vx</liability_gl_account_id>\n <revenue_gl_account_id>t5ejtgf2rf</revenue_gl_account_id>\n <performance_obligation_id>t5ejtge1xw</performance_obligation_id>\n <created_at type=\"datetime\">2019-05-03T23:16:05Z</created_at>\n <updated_at type=\"datetime\">2019-05-03T23:16:05Z</updated_at>\n </shipping_method>\n <shipping_method href=\"https://api.recurly.com/v2/shipping_methods/slow_boat\">\n <code>slow_boat</code>\n <name>Slow Boat</name>\n <accounting_code></accounting_code>\n <liability_gl_account_id>t5ejtgf1vx</liability_gl_account_id>\n <revenue_gl_account_id>t5ejtgf2rf</revenue_gl_account_id>\n <performance_obligation_id>t5ejtge1xw</performance_obligation_id>\n <created_at type=\"datetime\">2019-05-04T16:36:22Z</created_at>\n <updated_at type=\"datetime\">2019-05-04T16:36:22Z</updated_at>\n </shipping_method>\n</shipping_methods>"
x-codeSamples:
- lang: PHP
source: "<?php\n\n$shipping_methods = Recurly_ShippingMethodList::get();\n\nforeach ($shipping_methods as $shipping_method) {\n print(\"ShippingMethod: $shipping_method->name\\n\");\n}"
- lang: Ruby
source: "Recurly::ShippingMethod.find_each(per_page: 200) do |shipping_method|\n puts shipping_method.code\nend"
- lang: Python
source: "page_size = 200\n\nfor shipping_method in recurly.ShippingMethod.all(per_page = page_size):\n print(shipping_method.name)"
- lang: Dotnet
source: "using System.Linq;\n\nvar shippingMethods = ShippingMethods.List();\nwhile (shippingMethods.Any())\n{\n foreach (var shippingMethod in shippingMethods)\n Console.WriteLine(\"Shipping Method: \" + shippingMethod.Name);\n shippingMethods = shippingMethods.Next;\n}"
/shipping_methods/{shipping_method_code}:
get:
summary: Lookup Shipping Method
description: For additional information regarding shipping methods, please see https://docs.recurly.com/docs/shipping
tags:
- shipping-fees
operationId: lookupShippingMethod
parameters:
- in: path
required: true
name: shipping_method_code
schema:
type: string
default: ''
description: Unique code to identify a shipping method.
responses:
'200':
description: ''
content:
application/xml:
example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<shipping_method href=\"https://api.recurly.com/v2/shipping_methods/fast_fast_fast\">\n <code>fast_fast_fast</code>\n <name>Fast Fast Fast</name>\n <accounting_code></accounting_code>\n <tax_code></tax_code>\n <liability_gl_account_id>t5ejtgf1vx</liability_gl_account_id>\n <revenue_gl_account_id>t5ejtgf2rf</revenue_gl_account_id>\n <performance_obligation_id>t5ejtge1xw</performance_obligation_id>\n <created_at type=\"datetime\">2019-05-03T23:17:16Z</created_at>\n <updated_at type=\"datetime\">2019-05-03T23:17:16Z</updated_at>\n</shipping_method>"
schema:
$ref: '#/components/schemas/ShippingMethod'
x-codeSamples:
- lang: PHP
source: '<?php
$shipping_method = Recurly_ShippingMethod::get(''fast_fast_fast'');'
- lang: Ruby
source: shipping_method = Recurly::ShippingMethod.find 'fast_fast_fast'
- lang: Python
source: shipping_method = recurly.ShippingMethod.get('fast_fast_fast')
- lang: Dotnet
source: var shippingMethod = ShippingMethods.Get("fast_fast_fast");
components:
schemas:
GeneralLedgerAccountId:
type: string
title: General Ledger Account ID
description: 'The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.
'
maxLength: 13
example: iiznlrvdt8py
xml:
name: id
ShippingMethod:
type: object
properties:
object:
type: string
title: Object type
readOnly: true
code:
type: string
title: Code
description: The internal name used identify the shipping method.
maxLength: 50
name:
type: string
title: Name
description: The name of the shipping method displayed to customers.
maxLength: 100
accounting_code:
type: string
title: Accounting Code
description: Accounting code for shipping method.
maxLength: 20
tax_code:
type: string
title: Tax code
description: 'Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax
code values are specific to each tax system. If you are using Recurly’s
built-in taxes the values are:
- `FR` – Common Carrier FOB Destination
- `FR022000` – Common Carrier FOB Origin
- `FR020400` – Non Common Carrier FOB Destination
- `FR020500` – Non Common Carrier FOB Origin
- `FR010100` – Delivery by Company Vehicle Before Passage of Title
- `FR010200` – Delivery by Company Vehicle After Passage of Title
- `NT` – Non-Taxable
'
maxLength: 50
liability_gl_account_id:
$ref: '#/components/schemas/GeneralLedgerAccountId'
revenue_gl_account_id:
$ref: '#/components/schemas/GeneralLedgerAccountId'
performance_obligation_id:
$ref: '#/components/schemas/PerformanceObligationId'
created_at:
type: string
format: date-time
title: Created at
readOnly: true
updated_at:
type: string
format: date-time
title: Last updated at
readOnly: true
PerformanceObligationId:
type: string
title: Performance Obligation ID
description: 'The ID of a performance obligation. Performance obligations are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.
'
maxLength: 13
xml:
name: id
securitySchemes:
api_key:
type: http
description: Enter the API key as the username and set the password to an empty string. You can locate and manage your API keys from the [API Credentials](https://app.recurly.com/go/developer/api_keys) page.
scheme: basic