openapi/api.yaml in recurly-3.22.0 vs openapi/api.yaml in recurly-3.23.0
- old
+ new
@@ -55,11 +55,11 @@
version 3.18.1](https://github.com/recurly/recurly-client-ruby/releases/tag/3.18.1)
represents major version `3`, minor version `18` with patch `1`.
We encourage you to update to the latest version of the API and corresponding client library,
as most recent versions are more performant than their predecessors. See the
- [changelog](https://developers.recurly.com/api/changelog.html) for a comprehensive list of changes
+ [changelog](https://recurly.com/developers/api/changelog.html) for a comprehensive list of changes
introduced in the latest API version.
### Default Versions
Specifying a version is required to get a successful response. If you wish to
receive the latest version and are willing to accept the risk of breaking changes,
@@ -111,11 +111,11 @@
API and passing error messages to target systems, be mindful that
these messages may not make sense in the context of the target system.
Please consider changing these messages in target system to be better
suited to the audience of the system.
- Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
+ Please see [transaction error codes](https://recurly.com/developers/pages/api-transaction-errors.html) for more details.
## Pagination
### Response Schema
Every GET listing endpoint returns a response with the same schema:
@@ -178,11 +178,11 @@
header contains an integer value representing the time, measured in
seconds since the UNIX Epoch, at which the request count will be reset.
## Change Log
- A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2019-10-10).
+ A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2019-10-10).
version: v2019-10-10
security:
- api_key: []
x-tagGroups:
- name: Customers
@@ -302,10 +302,12 @@
- name: purchase
x-displayName: Purchase
description: A purchase is a checkout containing at least one or more subscriptions
or one-time charges (line items) and supports both coupon and gift card redemptions.
All items purchased will be on one invoice and paid for with one transaction.
+ The purchases endpoint can also be used to immediately create a credit invoice
+ on an account, when Credit Invoices is enabled on your site.
- name: usage
x-displayName: Usage
description: Send Recurly your customer usage and we will automatically bill them
in arrears at the end of the billing cycle. For more info on usage-based billing,
[click here](https://docs.recurly.com/docs/usage-based-billing).
@@ -341,11 +343,11 @@
operationId: list_sites
summary: List sites
description: |
This route is most useful for finding a site's ID for subsequent requests.
- See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
+ See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
tags:
- site
parameters:
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -540,12 +542,12 @@
get:
tags:
- account
operationId: list_accounts
summary: List a site's accounts
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -2423,12 +2425,12 @@
get:
tags:
- billing_infos
operationId: list_billing_infos
summary: Get the list of billing information associated with an account
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/sort_dates"
@@ -2632,13 +2634,13 @@
"/sites/{site_id}/accounts/{account_id}/coupon_redemptions":
get:
tags:
- coupon_redemption
operationId: list_account_coupon_redemptions
- summary: Show the coupon redemptions for an account
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ summary: List the coupon redemptions for an account
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/sort_dates"
@@ -2721,11 +2723,11 @@
"/sites/{site_id}/accounts/{account_id}/coupon_redemptions/active":
get:
tags:
- coupon_redemption
operationId: get_active_coupon_redemption
- summary: Show the coupon redemption that is active on an account
+ summary: Fetch the coupon redemption that is active on an account
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
responses:
'200':
@@ -3084,12 +3086,12 @@
get:
tags:
- credit_payment
operationId: list_account_credit_payments
summary: List an account's credit payments
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -3179,12 +3181,12 @@
get:
tags:
- invoice
operationId: list_account_invoices
summary: List an account's invoices
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -3615,12 +3617,12 @@
get:
tags:
- line_item
operationId: list_account_line_items
summary: List an account's line items
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -3713,10 +3715,12 @@
post:
tags:
- line_item
operationId: create_line_item
summary: Create a new line item for the account
+ description: When using the Credit Invoices feature, utilize the purchases endpoint
+ in order to immediately post credit to a credit invoice.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
requestBody:
content:
@@ -3881,13 +3885,13 @@
"/sites/{site_id}/accounts/{account_id}/notes":
get:
tags:
- note
operationId: list_account_notes
- summary: Fetch a list of an account's notes
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ summary: List an account's notes
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
responses:
@@ -4090,12 +4094,12 @@
get:
tags:
- shipping_address
operationId: list_shipping_addresses
summary: Fetch a list of an account's shipping addresses
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -4769,12 +4773,12 @@
get:
tags:
- subscription
operationId: list_account_subscriptions
summary: List an account's subscriptions
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -4865,12 +4869,12 @@
get:
tags:
- transaction
operationId: list_account_transactions
summary: List an account's transactions
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -4963,12 +4967,12 @@
get:
tags:
- account
operationId: list_child_accounts
summary: List an account's child accounts
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/account_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -5038,12 +5042,12 @@
get:
tags:
- account_acquisition
operationId: list_account_acquisition
summary: List a site's account acquisition data
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -5130,12 +5134,12 @@
get:
tags:
- coupon
operationId: list_coupons
summary: List a site's coupons
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -5993,12 +5997,12 @@
get:
tags:
- unique_coupon_code
operationId: list_unique_coupon_codes
summary: List unique coupon codes associated with a bulk coupon
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/coupon_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -6030,12 +6034,12 @@
get:
tags:
- credit_payment
operationId: list_credit_payments
summary: List a site's credit payments
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
- "$ref": "#/components/parameters/sort_dates"
@@ -6149,12 +6153,12 @@
get:
tags:
- custom_field_definition
operationId: list_custom_field_definitions
summary: List a site's custom field definitions
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -6167,10 +6171,11 @@
schema:
type: string
enum:
- account
- item
+ - plan
- subscription
responses:
'200':
description: A list of the site's custom field definitions.
content:
@@ -6367,12 +6372,12 @@
get:
tags:
- item
operationId: list_items
summary: List a site's items
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -7189,12 +7194,12 @@
get:
tags:
- measured_unit
operationId: list_measured_unit
summary: List a site's measured units
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -7375,12 +7380,12 @@
get:
tags:
- invoice
operationId: list_invoices
summary: List a site's invoices
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -7866,10 +7871,48 @@
var_dump($e);
} catch (\Recurly\RecurlyError $e) {
// Something bad happened... tell the user so that they can fix it?
echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
}
+ "/sites/{site_id}/invoices/{invoice_id}/apply_credit_balance":
+ put:
+ tags:
+ - invoice
+ operationId: apply_credit_balance
+ summary: Apply available credit to a pending or past due charge invoice
+ description: Apply credit payment to the outstanding balance on an existing
+ charge invoice from an account’s available balance from existing credit invoices.
+ parameters:
+ - "$ref": "#/components/parameters/site_id"
+ - "$ref": "#/components/parameters/invoice_id"
+ responses:
+ '200':
+ description: The updated invoice.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Invoice"
+ '404':
+ description: Incorrect site or invoice ID.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Error"
+ '422':
+ description: Tried applying credit to a legacy or closed invoice or there
+ was an error processing the credit payment.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Error"
+ default:
+ description: Unexpected error.
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/Error"
+ x-code-samples: []
"/sites/{site_id}/invoices/{invoice_id}/collect":
put:
tags:
- invoice
operationId: collect_invoice
@@ -8555,12 +8598,12 @@
get:
tags:
- line_item
operationId: list_invoice_line_items
summary: List an invoice's line items
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/invoice_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -8656,13 +8699,13 @@
"/sites/{site_id}/invoices/{invoice_id}/coupon_redemptions":
get:
tags:
- coupon_redemption
operationId: list_invoice_coupon_redemptions
- summary: Show the coupon redemptions applied to an invoice
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ summary: List the coupon redemptions applied to an invoice
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/invoice_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/sort_dates"
@@ -8754,11 +8797,11 @@
description: |
Related invoices provide a link between credit invoices and the charge invoices that they are refunding.
For a charge invoice the related invoices will be credit invoices.
For a credit invoice the related invoices will be charge invoices.
- See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
+ See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/invoice_id"
responses:
'200':
@@ -9004,12 +9047,12 @@
get:
tags:
- line_item
operationId: list_line_items
summary: List a site's line items
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -9334,12 +9377,12 @@
get:
tags:
- plan
operationId: list_plans
summary: List a site's plans
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -9995,12 +10038,12 @@
get:
tags:
- add-on
operationId: list_plan_add_ons
summary: List a plan's add-ons
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/plan_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -10657,12 +10700,12 @@
get:
tags:
- add-on
operationId: list_add_ons
summary: List a site's add-ons
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -10867,12 +10910,12 @@
get:
tags:
- shipping_method
operationId: list_shipping_methods
summary: List a site's shipping methods
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -11118,12 +11161,12 @@
get:
tags:
- subscription
operationId: list_subscriptions
summary: List a site's subscriptions
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -12910,12 +12953,12 @@
get:
tags:
- invoice
operationId: list_subscription_invoices
summary: List a subscription's invoices
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/subscription_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -13007,12 +13050,12 @@
get:
tags:
- line_item
operationId: list_subscription_line_items
summary: List a subscription's line items
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/subscription_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
@@ -13105,13 +13148,13 @@
"/sites/{site_id}/subscriptions/{subscription_id}/coupon_redemptions":
get:
tags:
- coupon_redemption
operationId: list_subscription_coupon_redemptions
- summary: Show the coupon redemptions for a subscription
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ summary: List the coupon redemptions for a subscription
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/subscription_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/sort_dates"
@@ -13400,12 +13443,12 @@
get:
tags:
- transaction
operationId: list_transactions
summary: List a site's transactions
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/site_id"
- "$ref": "#/components/parameters/ids"
- "$ref": "#/components/parameters/limit"
- "$ref": "#/components/parameters/order"
@@ -14401,13 +14444,13 @@
"/sites/{site_id}/dunning_campaigns":
get:
tags:
- dunning_campaigns
operationId: list_dunning_campaigns
- summary: Show the dunning campaigns for a site
- description: See the [Pagination Guide](/guides/pagination.html) to learn how
- to use pagination in the API and Client Libraries.
+ summary: List the dunning campaigns for a site
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
+ to learn how to use pagination in the API and Client Libraries.
parameters:
- "$ref": "#/components/parameters/sort_dates"
responses:
'200':
description: A list of the the dunning_campaigns on an account.
@@ -14433,11 +14476,11 @@
- "$ref": "#/components/parameters/dunning_campaign_id"
get:
tags:
- dunning_campaigns
operationId: get_dunning_campaign
- summary: Show the settings for a dunning campaign
+ summary: Fetch a dunning campaign
responses:
'200':
description: Settings for a dunning campaign.
content:
application/json:
@@ -15721,13 +15764,19 @@
title: Amount
description: Total amount the account is past due.
processing_prepayment_amount:
type: number
format: float
- title: Amount
+ title: Processing Prepayment Amount
description: Total amount for the prepayment credit invoices in a `processing`
state on the account.
+ available_credit_amount:
+ type: number
+ format: float
+ title: Available Credit Amount
+ description: Total amount of the open balances on credit invoices for the
+ account.
InvoiceAddress:
allOf:
- "$ref": "#/components/schemas/Address"
type: object
properties:
@@ -16059,11 +16108,11 @@
- price
- percentage
title: Usage Type
description: |
Type of usage, required if `add_on_type` is `usage`. See our
- [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
+ [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
for an overview of how to configure usage add-ons.
usage_percentage:
type: number
format: float
title: Usage Percentage
@@ -16175,11 +16224,11 @@
type: string
title: Tier type
description: |
The pricing model for the add-on. For more information,
[click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See
- our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview
+ our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview
of how to configure quantity-based pricing models.
default: flat
enum:
- flat
- tiered
@@ -16426,11 +16475,11 @@
type: object
properties:
token_id:
type: string
title: Token ID
- description: A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+ description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
maxLength: 22
first_name:
type: string
title: First name
maxLength: 50
@@ -17289,10 +17338,11 @@
type: string
title: Related Recurly object type
enum:
- account
- item
+ - plan
- subscription
name:
type: string
title: Name
description: Used by the API to identify the field or reading and writing.
@@ -18867,10 +18917,12 @@
ramp_intervals:
type: array
title: Ramp Intervals
items:
"$ref": "#/components/schemas/PlanRampInterval"
+ custom_fields:
+ "$ref": "#/components/schemas/CustomFields"
accounting_code:
type: string
title: Plan accounting code
description: Accounting code for invoice line items for the plan. If no
value is provided, it defaults to plan's code.
@@ -19061,10 +19113,12 @@
ramp_intervals:
type: array
title: Ramp Intervals
items:
"$ref": "#/components/schemas/PlanRampInterval"
+ custom_fields:
+ "$ref": "#/components/schemas/CustomFields"
revenue_schedule_type:
type: string
title: Revenue schedule type
enum:
- never
@@ -19275,10 +19329,12 @@
ramp_intervals:
type: array
title: Ramp Intervals
items:
"$ref": "#/components/schemas/PlanRampInterval"
+ custom_fields:
+ "$ref": "#/components/schemas/CustomFields"
revenue_schedule_type:
type: string
title: Revenue schedule type
enum:
- never
@@ -20255,19 +20311,19 @@
minItems: 1
description: |
If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
must include one to many tiers with `ending_quantity` and `unit_amount`.
There must be one tier with an `ending_quantity` of 999999999 which is the
- default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
+ default if not provided. See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
for an overview of how to configure quantity-based pricing models.
usage_percentage:
type: number
format: float
title: Usage Percentage
description: The percentage taken of the monetary amount of usage tracked.
This can be up to 4 decimal places. A value between 0.0 and 100.0. Required
if `add_on_type` is usage and `usage_type` is percentage. Must be omitted
- otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
+ otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
for an overview of how to configure usage add-ons.
revenue_schedule_type:
type: string
title: Revenue schedule type
enum: