Recurly · Schema
BillingAttemptDto
SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook
Properties
| Name | Type | Description |
|---|---|---|
| id | string | |
| createdAt | string | |
| updatedAt | string | |
| externalId | string | |
| subscriptionId | string | |
| relatedSubscriptionIds | array | Every subscription this billing attempt covers. For a combined order, this includes the driver subscription (subscriptionId) plus every other subscription billed in the same attempt. For a solo billin |
| orderId | stringnull | |
| errorMsg | stringnull | |
| errorCode | stringnull | |
| ready | boolean | Whether the billing attempt is still processing. |
| trigger | stringnull | |
| paymentMethodExternalId | stringnull | The shopify payment method card ID |
| paymentMethodType | stringnull | The payment method card type |
| paymentMethodLast4Digits | stringnull | The payment method last 4 digits |
| paymentMethodExpiryMonth | stringnull | The payment method expiry month |
| paymentMethodExpiryYear | stringnull | The payment method expiry year |
| paymentMethodBrand | stringnull | The payment method card brand |
| paymentMethodEmail | stringnull | The payment method email (only shows for paypal payment type) |
| paymentMethodName | stringnull | The payment method name |
| baseOrderChargedAmount | number | The charged amount of the based order associated with the billing attempt if exists |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/recurly/json-schema/recurly-billing-attempt-dto-schema.json",
"title": "BillingAttemptDto",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/recurly-commerce-openapi.yml#/components/schemas/BillingAttemptDto",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"externalId": {
"type": "string"
},
"subscriptionId": {
"type": "string"
},
"relatedSubscriptionIds": {
"description": "Every subscription this billing attempt covers. For a combined order, this includes the driver subscription (subscriptionId) plus every other subscription billed in the same attempt. For a solo billing attempt, this is just [subscriptionId].",
"type": "array",
"items": {
"type": "string"
}
},
"orderId": {
"type": [
"string",
"null"
]
},
"errorMsg": {
"type": [
"string",
"null"
]
},
"errorCode": {
"type": [
"string",
"null"
]
},
"ready": {
"type": "boolean",
"description": "Whether the billing attempt is still processing."
},
"trigger": {
"type": [
"string",
"null"
],
"enum": [
"RENEWAL_TASK",
"ANCHOR_RENEWAL_TASK",
"DUNNING_RETRY",
"UPDATE_PAYMENT_METHOD",
"PROCESS_NOW"
]
},
"paymentMethodExternalId": {
"type": [
"string",
"null"
],
"description": "The shopify payment method card ID"
},
"paymentMethodType": {
"type": [
"string",
"null"
],
"description": "The payment method card type",
"enum": [
"CustomerCreditCard",
"CustomerPaypalBillingAgreement",
"CustomerShopPayAgreement"
]
},
"paymentMethodLast4Digits": {
"type": [
"string",
"null"
],
"description": "The payment method last 4 digits"
},
"paymentMethodExpiryMonth": {
"type": [
"string",
"null"
],
"description": "The payment method expiry month"
},
"paymentMethodExpiryYear": {
"type": [
"string",
"null"
],
"description": "The payment method expiry year"
},
"paymentMethodBrand": {
"type": [
"string",
"null"
],
"description": "The payment method card brand"
},
"paymentMethodEmail": {
"type": [
"string",
"null"
],
"description": "The payment method email (only shows for paypal payment type)"
},
"paymentMethodName": {
"type": [
"string",
"null"
],
"description": "The payment method name"
},
"baseOrderChargedAmount": {
"type": "number",
"description": "The charged amount of the based order associated with the billing attempt if exists"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"externalId",
"subscriptionId",
"relatedSubscriptionIds",
"orderId",
"errorMsg",
"errorCode",
"ready",
"trigger",
"paymentMethodExternalId",
"paymentMethodType",
"paymentMethodLast4Digits",
"paymentMethodExpiryMonth",
"paymentMethodExpiryYear",
"paymentMethodBrand",
"paymentMethodEmail",
"paymentMethodName"
]
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/recurly-billing-attempt-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API 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.