| Field | Description |
|---|---|
| id | The RevCent ID of the customer. |
| first_name | The first name of the customer. |
| last_name | The last name of the customer. |
| address_line_1 | The customers' address line 1. |
| The customers' email address. | |
| internal_id | The customers' internal_id. |
| ip_address | The IP address of the customer. |
| phone | The customers' phone number. |
| metadata | All metadata values within a customer. |
Copyright 2024 My Company
www.mycompany.comCopyright 2024 My Company
www.mycompany.comThank you {{customer.first_name}} for purchasing from {{custom_data.store_name}}. We hope you enjoy your product!
"]},"template_trigger":{"description":"Event that triggers the template. api_direct identifies templates intended for SendSMTPMessage; no_trigger identifies a template with no automatic trigger.","type":"string","examples":["no_trigger","api_direct","sale_create_success","sale_create_decline","pending_sale_no_payment","sentinel_alert_create_success","ai_memo_create_success","fraud_alert_create_success","fraud_detection_create_success","customer_create_success","pending_refund_create_success","shipping_item_created","shipping_item_shipped","shipping_item_delivered","shipping_item_voided","subscription_renew_success","subscription_renew_decline","subscription_renewal_upcoming","trial_expire_success","trial_expire_decline","trial_expire_upcoming"],"enum":["no_trigger","api_direct","sale_create_success","sale_create_decline","pending_sale_no_payment","sentinel_alert_create_success","ai_memo_create_success","fraud_alert_create_success","fraud_detection_create_success","customer_create_success","pending_refund_create_success","shipping_item_created","shipping_item_shipped","shipping_item_delivered","shipping_item_voided","subscription_renew_success","subscription_renew_decline","subscription_renewal_upcoming","trial_expire_success","trial_expire_decline","trial_expire_upcoming"]},"trigger_sources_allowed":{"type":"array","description":"Allowed shipment origins for shipping_item_shipped and shipping_item_delivered triggers: a new sale, subscription renewal or trial expiration. Returns up to 50 values.","items":{"type":"string","examples":["sale_create","subscription_renew","trial_expire"],"enum":["sale_create","subscription_renew","trial_expire"]},"maxItems":50},"timing":{"type":"object","additionalProperties":false,"description":"Timing settings relative to the triggering event. When disabled, enabled is false, time_value is 0, time_unit is hours and time_relative is after.","properties":{"enabled":{"description":"Whether timing is enabled. A zero time_value does not by itself mean timing is disabled.","type":"boolean","examples":[false]},"time_unit":{"description":"Unit for time_value: hours, days, weeks, months or years. Returns hours when timing is disabled or the unit is unavailable.","type":"string","examples":["hours","days","weeks","months","years"],"enum":["hours","days","weeks","months","years"]},"time_value":{"description":"Nonnegative whole number of time units. Returns 0 when timing is disabled or no usable value is available; may also be 0 when enabled.","type":"integer","examples":[3600],"minimum":0},"time_relative":{"type":"string","description":"Whether the timing is before or after the triggering event. Returns after when timing is disabled or the setting is unavailable.","examples":["after","before"],"enum":["after","before"]}}},"filters":{"type":"object","additionalProperties":false,"description":"Configured event filters, returned as related-resource summaries. Each list contains up to 50 entries and may be empty.","properties":{"campaign":{"description":"Campaign summaries for this event filter. Returns up to 50 entries; may be empty.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"20 character RevCent ID of the campaign.","examples":["LY4o2550jwcbXW6GjZnJ"],"minLength":20,"maxLength":20},"name":{"description":"Name of the campaign. May be empty.","type":"string","examples":["My Campaign"]}}},"maxItems":50},"product":{"description":"Product summaries for this event filter. Returns up to 50 entries; may be empty.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"20 character RevCent ID of the product.","examples":["LY4o2550jwcbXW6GjZnJ"],"minLength":20,"maxLength":20},"name":{"description":"Name of the product. May be empty.","type":"string","examples":["My Product"]}}},"maxItems":50},"product_group":{"description":"Product group summaries for this event filter. Returns up to 50 entries; may be empty.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"20 character RevCent ID of the product group.","examples":["LY4o2550jwcbXW6GjZnJ"],"minLength":20,"maxLength":20},"name":{"description":"Name of the product group. May be empty.","type":"string","examples":["My Product Group"]}}},"maxItems":50},"third_party_shop":{"description":"Third-party shop summaries for this event filter. Returns up to 50 entries; may be empty.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"20 character RevCent ID of the third-party shop.","examples":["LY4o2550jwcbXW6GjZnJ"],"minLength":20,"maxLength":20},"name":{"description":"Name of the third-party shop. May be empty.","type":"string","examples":["My Store"]}}},"maxItems":50}}},"custom_data":{"type":"object","additionalProperties":false,"description":"Custom data configuration used by Handlebars placeholders such as {{custom_data.store_name}}. When disabled or unavailable, only enabled:false is returned; source_type and source_value are omitted.","properties":{"enabled":{"description":"Whether a usable custom data configuration is available.","type":"boolean","examples":[false]},"source_type":{"description":"Source of custom data: custom_function or json. Returned only when custom data is enabled.","type":"string","examples":["custom_function","json"],"enum":["custom_function","json"]},"source_value":{"description":"Source text: a 20 character RevCent ID of a function for custom_function, or JSON text for json. Returned only when custom data is enabled.","type":"string","examples":["LY4o2550jwcbXW6GjZnJ","{\"rest\":\"TESst\"}"]}}},"custom_arguments":{"description":"Argument names and instructions to use when preparing custom_arguments for SendSMTPMessage. Returns up to 50 entries. Review each description to determine the value to supply.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"Argument name to use in the custom_arguments input of SendSMTPMessage.","type":"string","examples":["thank_you_paragraph"]},"description":{"description":"Instructions describing the value to supply for this custom argument when sending the message.","type":"string","examples":["Generate a customized thank you paragraph based on the customers name."]}}},"maxItems":50},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time","examples":[1675367500]}},"title":"APICallResponseInfo","type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}},"post":{"summary":"Edit An Email Template","description":"Edit a previously created Email Template using the Email Template ID. Only supplied fields are updated.","operationId":"EditEmailTemplate","x-api-permission-description":"Allows the editing of email templates.","x-api-permission":"email_template:edit","x-ai-options":["mcp"],"x-kb-link":"https://kb.revcent.com/en/integrations/smtp/email-template","x-kb-name":"Email Templates","x-md-link":"markdown/mcp/operation/EditEmailTemplate.md","tags":["Email Templates"],"parameters":[{"in":"path","name":"email_template_id","description":"The Email Template ID","required":true,"schema":{"type":"string","title":"Email Template ID","description":"A 20 character Email Template ID.","minLength":20,"maxLength":20,"examples":["Q4vj0drE55FJb1XNmgL4"]}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"description":"The name of the Email Template. Must be unique from other Email Template names. Must contain at least one non-whitespace character; surrounding whitespace is trimmed.","type":"string","examples":["Example"]},"description":{"description":"The description of the Email Template. Omit to keep the current description. Send an empty string to clear it.","type":"string","examples":["Example description"]},"enabled":{"description":"Whether the Email Template is currently enabled and able to send SMTP messages. If an Email Template is disabled it should not be used to send a SMTP message","type":"boolean"},"smtp_profile":{"type":"string","description":"A 20 character SMTP Profile ID that is used to send the email.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"template_subject":{"description":"The subject line of the email when sending an SMTP message using the Email Template. Handlebars shortcode is available for this field. Shortcodes can be used within the subject line to have dynamic values when sending an SMTP message. For example, use the handlebars shortcode '{{customer.first_name}}' to have the customers first name dynamically inserted into the subject line when sending an SMTP message. Must contain at least one non-whitespace character; surrounding whitespace is trimmed.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"template_from":{"description":"The email address of the sender for the Email Template. Should match the send from email associated with the email templates' SMTP profile to prevent delivery issues. Handlebars shortcode is available for this field. Must contain at least one non-whitespace character; surrounding whitespace is trimmed.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"template_from_name":{"description":"The name of the sender for the Email Template. Handlebars shortcode is available for this field.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"template_to":{"description":"An array of email address shortcodes or actual email addresses that determine the to recipients when sending an SMTP message. Use the shortcode '{{customer.email}}' to utilize the email address of the customer related to the email, if applicable, when sending an SMTP message. Handlebars shortcode is available for this field. Include at least one nonblank recipient. Surrounding whitespace is trimmed and blank entries are ignored.","type":"array","items":{"type":"string","description":"An individual email address shortcode or actual email address.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"minItems":1,"contains":{"type":"string","description":"At least one recipient must contain non-whitespace text."}},"template_to_cc":{"description":"An array of email address shortcodes or actual email addresses that determine the CC recipients when sending an SMTP message. Use the shortcode '{{customer.email}}' to utilize the email address of the customer related to the email, if applicable, when sending an SMTP message. Handlebars shortcode is available for this field.","type":"array","items":{"type":"string","description":"An individual email address shortcode or actual email address.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"template_to_bcc":{"description":"An array of email address shortcodes or actual email addresses that determine the BCC recipients when sending an SMTP message. Use the shortcode '{{customer.email}}' to utilize the email address of the customer related to the email, if applicable, when sending an SMTP message. Handlebars shortcode is available for this field.","type":"array","items":{"type":"string","description":"An individual email address shortcode or actual email address.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"template_html":{"description":"Replacement HTML for the email body, using Handlebars expressions. Omit to preserve the existing body. Replacing the body preserves existing CSS. Must contain at least one non-whitespace character; surrounding whitespace is trimmed.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"template_trigger":{"description":"The trigger setting determines how the Email Template can be triggered to send a SMTP message. An Email Template with a trigger setting of 'api_direct' can be used to send a SMTP message directly via the API using the SendSMTPMessage operation, otherwise the email template is triggered when the specified event occurs within your RevCent account.| Field | Description |
|---|---|
| id | The RevCent ID of the project. |
| name | The name of the project. |
| description | The description of the project. |
| Field | Description |
|---|---|
| id | The RevCent ID of the project note. |
| title | The title of the project note. |
| content | The content of the project note. |
| metadata | All metadata values within a project note. |
| Field | Description |
|---|---|
| id | The RevCent ID of the shipment. |
| ship_to_first_name | The ship to first name for the shipment. |
| ship_to_last_name | The ship to last name for the shipment. |
| ship_to_address_line_1 | The ship to address line 1. |
| provider_tracking | The shipment tracking number. |
| metadata | All metadata values within a shipment. |
| fulfillment_account_order_id | The order identifier assigned by the fulfillment account. |
Thanks for buying our product.
"]},"email_template":{"additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the Email Template.","type":"string","title":"Email Template ID","minLength":20,"maxLength":20,"examples":["Q4vj0drE55FJb1XNmgL4"]},"name":{"type":"string","description":"The name of the Email Template.","examples":["My Email Template"]}},"type":["object","null"],"description":"Available Email Template summary, or null when unavailable or unusable."},"smtp_profile":{"additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the SMTP Profile.","type":"string","title":"SMTP Profile ID","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]},"name":{"type":"string","description":"The name of the SMTP Profile.","examples":["My SMTP Profile"]}},"type":["object","null"],"description":"Available SMTP Profile summary, or null when unavailable or unusable."},"customer":{"type":["object","null"],"description":"Available customer summary, or null when unavailable or unusable.","additionalProperties":false,"properties":{"address_line_1":{"type":"string","description":"The customer first address line.","examples":["1600 Pennsylvania Ave"]},"address_line_2":{"type":"string","description":"The customer second address line.","examples":["West Wing"]},"blocked":{"type":"boolean","description":"Whether the customer is blocked.","examples":[false]},"city":{"type":"string","description":"The customer city.","examples":["Washington"]},"company":{"type":"string","description":"The customer company.","examples":["Acme Inc."]},"country":{"type":"string","description":"Customer country, normally an ISO 3 country code. Historical country text may also be returned.","examples":["USA"]},"email":{"type":"string","description":"Customer email address; historical text may also be returned.","examples":["georgew@whitehouse.gov"]},"first_name":{"type":"string","description":"The customer first name.","examples":["George"]},"internal_id":{"type":"string","description":"The consumer's own reference for the customer.","examples":["pres_01"]},"last_name":{"type":"string","description":"The customer last name.","examples":["Washington"]},"phone":{"type":"string","description":"Customer phone number.","examples":["1234567890"]},"state":{"type":"string","description":"Customer state or province.","examples":["DC"]},"zip":{"type":"string","description":"Customer ZIP or postal code.","examples":["20500"]},"created_date_unix":{"description":"Unix timestamp in seconds when the customer was created.","type":"integer","format":"unix-time","examples":[1675367500]},"id":{"description":"20 character RevCent ID of the customer.","title":"Customer ID","type":"string","minLength":20,"maxLength":20,"examples":["4r158EzJmmcVM69dNLkg"]},"enabled":{"type":"boolean","description":"Whether the customer is enabled."},"metadata":{"items":{"additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100,"examples":["website"]},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255,"examples":["mystore.com"]}},"type":"object"},"type":"array","description":"Up to 50 available metadata name/value pairs, preserving their text and order. Duplicate pairs may be returned; this list may be incomplete.","maxItems":50},"updated_date_unix":{"description":"Unix timestamp in seconds when the customer was last updated.","type":"integer","format":"unix-time","examples":[1675367500]},"status":{"description":"Customer status, separate from the message outcome.","enum":["Chargeback","Fraud Detected","Blocked","Disabled","Enabled"],"type":"string","examples":["Chargeback"]}}},"updated_date_unix":{"description":"Message-record update time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"sales":{"items":{"description":"20 character RevCent ID of the sale.","type":"string","minLength":20,"maxLength":20,"examples":["k6vnbJom00Ug89mpRj78"]},"type":"array","description":"Available directly associated IDs, at most 50; this is not a complete relationship history. Retrieve the details of each sale_id using the GetSale operation.","maxItems":50},"product_sales":{"items":{"description":"20 character RevCent ID of the product sale.","type":"string","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hbPzpBn8aY"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related product sales exist.","maxItems":50},"shipping":{"items":{"description":"20 character RevCent ID of the shipping.","type":"string","minLength":20,"maxLength":20,"examples":["gYamRbaGZphKn8zJVow1"]},"type":"array","description":"Available directly associated IDs, at most 50; this is not a complete relationship history. Retrieve the details of each shipping_id using the GetShipment operation.","maxItems":50},"tax":{"items":{"description":"20 character RevCent ID of the tax.","type":"string","minLength":20,"maxLength":20,"examples":["MW5LoAVymnHww96XllEr"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related tax exist.","maxItems":50},"discounts":{"items":{"description":"20 character RevCent ID of the discount.","type":"string","minLength":20,"maxLength":20,"examples":["5r1wN8EbAgsPvLlbMava"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related discounts exist.","maxItems":50},"trials":{"items":{"description":"20 character RevCent ID of the trial.","type":"string","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hb6o2Pvl5j"]},"type":"array","description":"Available directly associated IDs, at most 50; this is not a complete relationship history. Retrieve the details of each trial_id using the GetTrial operation.","maxItems":50},"subscriptions":{"items":{"description":"20 character RevCent ID of the subscription.","type":"string","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"type":"array","description":"Available directly associated IDs, at most 50; this is not a complete relationship history. Retrieve the details of each subscription_id using the GetSubscription operation.","maxItems":50},"subscription_renewals":{"items":{"description":"20 character RevCent ID of the subscription renewal.","type":"string","minLength":20,"maxLength":20,"examples":["YaVqjA1JowiGpyEN0o55"]},"type":"array","description":"Available directly associated IDs, at most 50; this is not a complete relationship history. Retrieve the details of each subscription_renewal_id using the GetSubscriptionRenewal operation.","maxItems":50},"transactions":{"items":{"description":"20 character RevCent ID of the transaction.","type":"string","minLength":20,"maxLength":20,"examples":["d9ZoKG0n2pIwBG60Q6aW"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related transactions exist.","maxItems":50},"ai_threads":{"items":{"description":"20 character RevCent ID of the AI Thread.","type":"string","title":"AI Thread ID","minLength":20,"maxLength":20,"examples":["V1q65avW45Spn1kbY9yV"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related ai threads exist.","maxItems":50},"ai_assistants":{"items":{"description":"20 character RevCent ID of the AI Assistant.","type":"string","title":"AI Assistant ID","minLength":20,"maxLength":20,"examples":["WgNQmKrM1LT9Jj4pAvk6"]},"type":"array","description":"Available directly associated IDs, at most 50; this is not a complete relationship history. Retrieve the details of each ai_assistant_id using the GetAIAssistant operation.","maxItems":50},"paypal_transactions":{"items":{"description":"20 character RevCent ID of the PayPal transaction.","type":"string","minLength":20,"maxLength":20,"examples":["k6omOdKbrRTZnpP6d7Ng"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related paypal transactions exist.","maxItems":50},"offline_payments":{"items":{"description":"20 character RevCent ID of the offline payment.","type":"string","minLength":20,"maxLength":20,"examples":["zGldyKJGORfkP1O1vJ4B"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related offline payments exist.","maxItems":50},"check_directs":{"items":{"description":"20 character RevCent ID of the check direct.","type":"string","minLength":20,"maxLength":20,"examples":["GO51EXbbAPS6pP1Ov9kK"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related check directs exist.","maxItems":50},"salvage_transactions":{"items":{"description":"20 character RevCent ID of the salvage transaction.","type":"string","minLength":20,"maxLength":20,"examples":["VPm9Mqmgw7UJJLldojJY"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related salvage transactions exist.","maxItems":50},"pending_refunds":{"items":{"description":"20 character RevCent ID of the pending refund.","type":"string","minLength":20,"maxLength":20,"examples":["MW5LoAVymnHww96XllEr"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related pending refunds exist.","maxItems":50},"chargebacks":{"items":{"description":"20 character RevCent ID of the chargeback.","type":"string","minLength":20,"maxLength":20,"examples":["j0a9dNwVKqu8Qz5Vl6ZZ"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related chargebacks exist.","maxItems":50},"fraud_detections":{"items":{"description":"20 character RevCent ID of the fraud detection.","type":"string","minLength":20,"maxLength":20,"examples":["VPwOydX2ArHJy8gX2o98"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related fraud detections exist.","maxItems":50},"api_calls":{"items":{"description":"20 character RevCent ID of the API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"type":"array","description":"Currently returns an empty array; this does not establish that no related api calls exist.","maxItems":50},"message_result_code":{"description":"Recorded message outcome: current messages use 1 for success and 0 for failure. Historical finite numeric values may also be returned unchanged. This is separate from the root retrieval code and is not an SMTP protocol response code.","type":"number","examples":[0]},"trigger_identifier":{"description":"Available identifier of the trigger associated with the message; historical and empty strings may be returned.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/smtp_profiles":{"get":{"summary":"Get SMTP Profiles","description":"Retrieve available SMTP profile configurations in newest-first creation order. Only limit and page are accepted. Returned settings do not confirm successful connectivity or delivery.","operationId":"GetSMTPProfiles","x-api-permission-description":"Allows the retrieving of SMTP profiles.","x-api-permission":"smtp_profile:retrieve","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/GetSMTPProfiles.md","tags":["SMTP Profiles"],"parameters":[{"description":"Required number of results per page, from 1 to 25. There is no default when omitted. Repeated values use the last value.","in":"query","name":"limit","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25,"examples":[25]},"style":"form"},{"description":"Required page number from 0 to 20; 0 selects page 1. A page beyond the available results returns an empty array. total_pages may exceed 20. Repeated values use the last value.","in":"query","name":"page","required":true,"schema":{"type":"integer","format":"int32","examples":[1]},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"A page of available SMTP profile configurations and pagination totals.","properties":{"api_call_id":{"description":"20 character RevCent ID of this API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp in seconds when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"A value of 1 indicates successful retrieval.","type":"integer","format":"int32","enum":[1],"examples":[1]},"current_count":{"description":"Number of profiles returned on this page.","type":"integer","minimum":0,"maximum":25,"examples":[10]},"current_page":{"description":"Requested page, with zero normalized to one. Only pages through 20 are accessible.","type":"integer","minimum":1,"maximum":20,"examples":[1]},"results":{"items":{"type":"object","additionalProperties":false,"properties":{"created_date_unix":{"description":"Profile creation time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"id":{"description":"20 character RevCent ID of the SMTP profile. Use it with GetSMTPProfile for individual retrieval.","type":"string","title":"SMTP Profile ID","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]},"name":{"description":"Profile name; may be empty. Omitted when unavailable.","type":"string","examples":["My SMTP Profile"]},"description":{"description":"Profile description; may be empty. Omitted when unavailable.","type":"string","examples":["The SMTP profile used for sending transactional emails."]},"enabled":{"description":"Whether the SMTP profile is enabled. Omitted when unavailable.","type":"boolean","examples":[true]},"host":{"description":"Configured SMTP server hostname or address. May be empty or null; omitted when unavailable.","type":["string","null"],"examples":["smtp.mystore.com"]},"port":{"description":"Configured SMTP server port, as an integer or null. Historical integer values are preserved; omitted when unavailable.","type":["integer","null"],"examples":[587]},"use_ssl":{"description":"Whether the profile is configured to use SSL. Omitted when unavailable.","type":"boolean","examples":[true]},"require_tls":{"description":"Whether the profile is configured to require TLS. Omitted when unavailable.","type":"boolean","examples":[true]},"auth":{"type":"object","additionalProperties":false,"description":"SMTP authentication username and password placeholder.","properties":{"user":{"description":"Configured SMTP authentication username. May be empty or null; omitted when unavailable.","type":["string","null"],"examples":["smtp_user"]},"pass":{"description":"Fixed eight-asterisk placeholder. The actual password is never returned; this mask does not confirm that usable credentials are configured.","type":"string","const":"********","examples":["********"]}}},"updated_date_unix":{"description":"Profile update time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]}}},"type":"array","maxItems":25,"description":"Available SMTP Profile configurations in newest-first order. Empty when there are no matches or the requested page is beyond the results."},"total_count":{"description":"Number of available matching SMTP Profiles, including profiles beyond the requested page.","type":"integer","minimum":0,"examples":[28]},"total_pages":{"description":"Total_count divided by limit, rounded up; zero when there are no matches. May exceed the maximum requestable page of 20.","type":"integer","minimum":0,"examples":[3]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}},"post":{"summary":"Create A SMTP Profile","description":"Create an SMTP profile with authentication credentials.","operationId":"CreateSMTPProfile","x-api-permission-description":"Allows the creation of SMTP profiles.","x-api-permission":"smtp_profile:create","x-ai-options":["mcp"],"x-kb-link":"https://kb.revcent.com/en/integrations/smtp/smtp-profile","x-kb-name":"SMTP Profiles","x-md-link":"markdown/mcp/operation/CreateSMTPProfile.md","tags":["SMTP Profiles"],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"description":"The SMTP profile name.","type":"string","examples":["Example"]},"description":{"description":"The SMTP profile description.","type":"string","examples":["Example description"]},"enabled":{"description":"Whether the SMTP profile is currently enabled.","type":"boolean"},"host":{"description":"The SMTP profile host.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"port":{"description":"The SMTP profile port.","type":"integer","minimum":1,"maximum":65535,"examples":[1]},"use_ssl":{"description":"Whether the SMTP profile uses SSL.","type":"boolean"},"require_tls":{"description":"Whether the SMTP profile requires TLS.","type":"boolean"},"auth":{"type":"object","additionalProperties":false,"description":"SMTP authentication credentials. Supply auth or a completed secure_form_id when creating the profile. Unauthenticated SMTP profiles are not supported. If both are supplied, the secure form provides the authentication credentials.","properties":{"user":{"description":"The SMTP profile auth user.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"pass":{"description":"The password used to authenticate with the SMTP service. Must contain a non-whitespace character. The supplied value is preserved exactly, including leading and trailing whitespace.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"required":["user","pass"]},"secure_form_id":{"type":"string","description":"A completed secure form ID. Create the form with CreateSecureForm, complete its form_url, and supply this ID to use the submitted credentials. Required when auth is omitted. If both are supplied, the secure form provides the authentication credentials. SMTP passwords must contain a non-whitespace character and are preserved exactly, including leading and trailing whitespace.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"idempotency_key":{"type":"string","minLength":11,"maxLength":255,"description":"Optional unique key for this specific request. Use 11–255 characters, preferably ASCII. Reuse the same key only when retransmitting the same request after a timeout or lost response. A recognized duplicate returns HTTP 400 with error_code E0583 without executing again; the original response is not returned, and the duplicate error does not establish the operation outcome. Keys are scoped to your account and API credential, across operations. Use a new key for each deliberate new operation. A failed request can consume its key. Other lengths provide no duplicate protection. Keys are not permanent resource identifiers.","examples":["6f312ce2-7959-4c1b-a8dd-591fc5c789cf"]}},"type":"object","required":["name","host","port"],"anyOf":[{"required":["auth"]},{"required":["secure_form_id"]}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"smtp_profile_id":{"type":"string","title":"SMTP Profile ID","description":"A 20 character SMTP Profile ID.","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/smtp_profiles/{smtp_profile_id}":{"get":{"summary":"Get A SMTP Profile","description":"Retrieve an SMTP profile configuration. Returned settings do not confirm successful connectivity or delivery. No query parameters are accepted.","operationId":"GetSMTPProfile","x-api-permission-description":"Allows the retrieving of SMTP profiles.","x-api-permission":"smtp_profile:retrieve","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/GetSMTPProfile.md","tags":["SMTP Profiles"],"parameters":[{"in":"path","name":"smtp_profile_id","description":"20 character RevCent ID of the SMTP profile to retrieve. Obtain it from GetSMTPProfiles.","required":true,"schema":{"description":"20 character RevCent ID of the SMTP profile.","type":"string","title":"SMTP Profile ID","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"The requested SMTP profile configuration.","properties":{"api_call_id":{"description":"20 character RevCent ID of this API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp in seconds when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"A value of 1 indicates successful retrieval.","type":"integer","enum":[1],"examples":[1]},"created_date_unix":{"description":"Profile creation time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"id":{"description":"20 character RevCent ID of the requested SMTP profile.","type":"string","title":"SMTP Profile ID","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]},"name":{"description":"Profile name; may be empty. Omitted when unavailable.","type":"string","examples":["My SMTP Profile"]},"description":{"description":"Profile description; may be empty. Omitted when unavailable.","type":"string","examples":["The SMTP profile used for sending transactional emails."]},"enabled":{"description":"Whether the SMTP profile is enabled. Omitted when unavailable.","type":"boolean","examples":[true]},"host":{"description":"Configured SMTP server hostname or address. May be empty or null; omitted when unavailable.","type":["string","null"],"examples":["smtp.mystore.com"]},"port":{"description":"Configured SMTP server port, as an integer or null. Historical integer values are preserved; omitted when unavailable.","type":["integer","null"],"examples":[587]},"use_ssl":{"description":"Whether the profile is configured to use SSL. Omitted when unavailable.","type":"boolean","examples":[true]},"require_tls":{"description":"Whether the profile is configured to require TLS. Omitted when unavailable.","type":"boolean","examples":[true]},"auth":{"type":"object","additionalProperties":false,"description":"SMTP authentication username and password placeholder.","properties":{"user":{"description":"Configured SMTP authentication username. May be empty or null; omitted when unavailable.","type":["string","null"],"examples":["smtp_user"]},"pass":{"description":"Fixed eight-asterisk placeholder. The actual password is never returned; this mask does not confirm that usable credentials are configured.","type":"string","const":"********","examples":["********"]}}},"updated_date_unix":{"description":"Profile update time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}},"post":{"summary":"Edit A SMTP Profile","description":"Edit a specific SMTP profile using the smtp_profile ID. Only supplied fields are updated.","operationId":"EditSMTPProfile","x-api-permission-description":"Allows the editing of SMTP profiles.","x-api-permission":"smtp_profile:edit","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/EditSMTPProfile.md","tags":["SMTP Profiles"],"parameters":[{"in":"path","name":"smtp_profile_id","description":"The SMTP profile ID.","required":true,"schema":{"type":"string","title":"SMTP Profile ID","description":"A 20 character SMTP Profile ID.","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"description":"The SMTP profile name.","type":"string","examples":["Example"]},"description":{"description":"The SMTP profile description. Omit to keep the current description. Send an empty string to clear it.","type":"string","examples":["Example description"]},"enabled":{"description":"Whether the SMTP profile is currently enabled.","type":"boolean"},"host":{"description":"The SMTP profile host.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"port":{"description":"The SMTP profile port.","type":"integer","minimum":1,"maximum":65535,"examples":[1]},"use_ssl":{"description":"Whether the SMTP profile uses SSL.","type":"boolean"},"require_tls":{"description":"Whether the SMTP profile requires TLS.","type":"boolean"},"auth":{"type":"object","additionalProperties":false,"description":"The SMTP profile auth settings.","properties":{"user":{"description":"The SMTP profile auth user.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"pass":{"description":"The password used to authenticate with the SMTP service. Must contain a non-whitespace character. The supplied value is preserved exactly, including leading and trailing whitespace.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"required":["user","pass"]},"secure_form_id":{"type":"string","description":"A completed secure form ID. Create the form with CreateSecureForm, complete its form_url, and supply this ID to use the submitted credentials. SMTP passwords must contain a non-whitespace character and are preserved exactly, including leading and trailing whitespace.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"idempotency_key":{"type":"string","minLength":11,"maxLength":255,"description":"Optional unique key for this specific request. Use 11–255 characters, preferably ASCII. Reuse the same key only when retransmitting the same request after a timeout or lost response. A recognized duplicate returns HTTP 400 with error_code E0583 without executing again; the original response is not returned, and the duplicate error does not establish the operation outcome. Keys are scoped to your account and API credential, across operations. Use a new key for each deliberate new operation. A failed request can consume its key. Other lengths provide no duplicate protection. Keys are not permanent resource identifiers.","examples":["6f312ce2-7959-4c1b-a8dd-591fc5c789cf"]}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"smtp_profile_id":{"type":"string","title":"SMTP Profile ID","description":"A 20 character SMTP Profile ID.","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/smtp_profiles/{smtp_profile_id}/delete":{"post":{"summary":"Delete A SMTP Profile","description":"Delete an existing SMTP profile.","operationId":"DeleteSmtpProfile","x-api-permission-description":"Allows the deletion of SMTP profiles.","x-api-permission":"smtp_profile:delete","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/DeleteSmtpProfile.md","tags":["SMTP Profiles"],"parameters":[{"in":"path","name":"smtp_profile_id","description":"The SMTP profile ID.","required":true,"schema":{"type":"string","title":"SMTP Profile ID","description":"A 20 character SMTP Profile ID.","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"smtp_profile_id":{"type":"string","title":"SMTP Profile ID","description":"A 20 character SMTP Profile ID.","minLength":20,"maxLength":20,"examples":["LY4o2550jwcbXW6GjZnJ"]},"result":{"type":"string","examples":["SMTP Profile deleted."]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions":{"get":{"summary":"Get Subscriptions","description":"Retrieve subscription summaries in newest-first order, including lifecycle status, billing information and available related resources.","operationId":"GetSubscriptions","x-api-permission-description":"Allows the retrieving of subscriptions.","x-api-permission":"subscription:retrieve","x-ai-options":["ai_assistant","mcp"],"x-additional-info":"date_start, date_end, limit and page are required. The date span must be strictly shorter than 9,900 days unless customer_id is supplied; customer_id does not remove the date requirement or date filtering.","x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/GetSubscriptions.md","x-ai-q":"Tell me how subscriptions work in RevCent and how they can help my ecommerce business manage recurring revenue effectively.","tags":["Subscriptions"],"parameters":[{"description":"Required inclusive start of the subscription creation-date range, as a nonnegative Unix timestamp in seconds. Must not exceed date_end; equal endpoints return an empty interval. Repeated values use the last value.","in":"query","name":"date_start","required":true,"schema":{"type":"integer","format":"unix-time","examples":[1627876799]},"style":"form"},{"description":"Required exclusive end of the subscription creation-date range, as a nonnegative Unix timestamp in seconds. The span must be strictly shorter than 9,900 days unless customer_id is supplied. Repeated values use the last value.","in":"query","name":"date_end","required":true,"schema":{"type":"integer","format":"unix-time","examples":[1628049599]},"style":"form"},{"description":"Required number of subscriptions per page, from 1 to 25; there is no default when omitted. Repeated values use the last value.","in":"query","name":"limit","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25,"examples":[25]},"style":"form"},{"description":"Required page number from 0 to 20; 0 selects page 1. Repeated values use the last value. Narrow the date range or filters when more than 20 pages match.","in":"query","name":"page","required":true,"schema":{"type":"integer","format":"int32","examples":[1]},"style":"form"},{"description":"Filter by up to 50 distinct 20 character RevCent IDs of associated campaign resources, supplied as repeated parameters. Values within this filter are alternatives; different filters combine.","name":"campaign_filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]}},"style":"form","explode":true},{"description":"Filter by up to 50 distinct, case-sensitive payment-type values supplied as repeated parameters. Values within this filter are alternatives; different filters combine.","name":"payment_type_filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["credit_card","paypal","offline","check_direct"],"examples":["credit_card","paypal","offline","check_direct"]}},"style":"form","explode":true},{"description":"Filter by up to 50 distinct 20 character RevCent IDs of associated product resources, supplied as repeated parameters. Values within this filter are alternatives; different filters combine.","name":"product_filter","in":"query","required":false,"schema":{"type":"array","items":{"title":"Product ID","type":"string","description":"A 20 character product ID.","minLength":20,"maxLength":20,"examples":["6r8O5MLbw2t6n4v1lGqK","r1Ebz4d6qaH05LPvWM1M"]}},"style":"form","explode":true},{"description":"Filter by up to 50 distinct 20 character RevCent IDs of associated subscription profile resources, supplied as repeated parameters. Values within this filter are alternatives; different filters combine.","name":"subscription_profile_filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20,"examples":["r1E1mnl41afb8La0mjMw","4R5RMnpA8ZSMMjEV2a21"]}},"style":"form","explode":true},{"description":"Filter by up to 50 distinct, case-sensitive values supplied as repeated parameters. All values within this filter use OR, including active, trial, overdue, occurrence_limit, suspended, cancelled, fraud, chargeback, expired and replaced. Different filters use AND. trial selects eligible trials whose start date has not passed. Filter values do not directly match every returned display status.","name":"status_filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["active","trial","overdue","occurrence_limit","suspended","expired","replaced","cancelled","fraud","chargeback"],"examples":["active","suspended"]}},"style":"form","explode":true},{"description":"Filter by up to 50 metadata name/value pairs, supplied as repeated JSON objects or bracketed name/value parameters. Names contain 1–100 characters and values 1–255. Values for the same name are alternatives; different names must all match. METADATA_NAME_EXISTS selects name presence regardless of value.","explode":true,"in":"query","name":"metadata_filter","required":false,"schema":{"items":{"additionalProperties":false,"required":["name","value"],"properties":{"name":{"type":"string","description":"The metadata name which must be present in an items metadata along with a matching value.","examples":["filter_metadata_name"]},"value":{"type":"string","description":"The metadata value associated with the metadata name. To filter ignoring the metadata value and just filter based on the presence of the metadata name, you can set the value to 'METADATA_NAME_EXISTS' and it will filter for items that have the metadata name regardless of the value.","examples":["Filter metadata value"]}},"type":"object"},"type":"array"},"style":"deepObject"},{"description":"20 character RevCent ID of the customer whose subscriptions to retrieve. Accepts one distinct ID. Removes only the date-span ceiling; date_start and date_end remain required and still filter results.","in":"query","name":"customer_id","required":false,"schema":{"type":"string","examples":["4r158EzJmmcVM69dNLkg"]},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"A page of subscription summaries and pagination totals.","properties":{"api_call_id":{"description":"20 character RevCent ID of this API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp in seconds when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"A value of 1 indicates successful retrieval, not a successful subscription payment.","type":"integer","format":"int32","enum":[1],"examples":[1]},"current_count":{"description":"Number of subscriptions returned on this page.","type":"integer","minimum":0,"maximum":25,"examples":[10]},"current_page":{"description":"Requested page, with zero selecting page one. Requests above page 20 are rejected.","type":"integer","minimum":1,"maximum":20,"examples":[1]},"results":{"items":{"type":"object","description":"Subscription summaries. Monetary values use major currency units; do not assume a denomination when currency is unavailable. Historical signed amounts and whole-number quantities are preserved.","additionalProperties":false,"properties":{"id":{"description":"The subscription's 20 character RevCent ID, for GetSubscription.","type":"string","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"created_date_unix":{"description":"Subscription creation time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"updated_date_unix":{"description":"Subscription update time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"amount":{"description":"Subscription amount in major units of iso_currency, rounded to two decimals. Omitted when unavailable or invalid; historical negative values are retained.","type":"number","format":"float","examples":[49.99]},"iso_currency":{"description":"Recognized three-letter ISO 4217 currency code, preserving saved case. Omitted when unavailable or unrecognized; no USD or other currency is assumed.","type":"string","examples":["USD"],"minLength":3,"maxLength":3},"live_mode":{"description":"Available live-mode flag for the subscription; omitted when unavailable.","type":"boolean","examples":[true]},"campaign_id":{"description":"Available campaign's 20 character RevCent ID, returned with campaign_name.","type":"string","title":"Campaign ID","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"Available campaign name, returned with campaign_id.","examples":["AdWords Campaign"]},"is_active":{"description":"Available active setting, independently of display status. True when unavailable; invalid nonboolean values are omitted.","type":"boolean","examples":[true]},"num_overdue":{"description":"Available overdue count; zero when unavailable. Historical whole-number values are retained; invalid values are omitted.","type":"integer","examples":[0]},"has_replacement":{"description":"Available flag that a replacement exists; false when unavailable. The replacement link can still be unavailable.","type":"boolean","examples":[false]},"is_replacement":{"description":"Available flag that this subscription replaces an earlier subscription; false when unavailable.","type":"boolean","examples":[false]},"is_suspended":{"description":"Available suspended setting, independently of display status. False when unavailable; invalid nonboolean values are omitted.","type":"boolean","examples":[false]},"is_cancelled":{"description":"Available cancelled setting, independently of display status. False when unavailable; invalid nonboolean values are omitted.","type":"boolean","examples":[false]},"is_overdue":{"description":"Available overdue setting, independently of display status. False when unavailable; invalid nonboolean values are omitted.","type":"boolean","examples":[false]},"is_occurrence_limit":{"description":"Whether renewal occurrences block further billing. A finite limit is reached using all available associated renewals, independently of the returned renewal IDs; an unusable finite-limit setting also blocks billing.","type":"boolean","examples":[false]},"status":{"description":"Subscription display status, distinct from lifecycle flags and status_filter choices. Occurrence restrictions can yield Occurrence Limit or Occurrence Error; qualifying fraud or chargebacks can override the display. Historical status text is preserved; unavailable text returns Error.","type":"string","examples":["Active","Overdue","Suspended","Cancelled","Occurrence Limit","Replaced"]},"subscription_start_date_unix":{"description":"Available subscription start time in Unix seconds, or null when unavailable or unusable.","type":["integer","null"],"format":"unix-time","examples":[1706030353]},"subscription_replaced":{"type":["object","null"],"description":"The earlier subscription that this subscription replaces, as an ID-only object; null when unavailable.","additionalProperties":false,"properties":{"id":{"type":"string","minLength":20,"maxLength":20,"description":"20 character RevCent ID of the earlier subscription replaced by this subscription.","examples":["WmPnWqPKbpFRmy6Ma2BG"]}}},"subscription_replaced_with":{"type":["object","null"],"description":"The replacement subscription that supersedes this subscription, as an ID-only object; null when unavailable.","additionalProperties":false,"properties":{"id":{"type":"string","minLength":20,"maxLength":20,"description":"20 character RevCent ID of the replacement that supersedes this subscription.","examples":["WmPnWqPKbpFRmy6Ma2BG"]}}},"metadata":{"items":{"type":"object","description":"A metadata entry.","additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100,"examples":["website"]},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255,"examples":["mystore.com"]}}},"type":"array","description":"Up to the first 50 valid metadata name/value pairs, preserving text, order and duplicates.","maxItems":50},"customer":{"type":"object","description":"Available customer summary; omitted when unavailable. Optional historical text is preserved.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the customer.","title":"Customer ID","type":"string","minLength":20,"maxLength":20,"examples":["4r158EzJmmcVM69dNLkg"]},"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time","examples":[1675367500]},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time","examples":[1675367500]},"internal_id":{"type":"string","description":"The consumer's own customer reference, when available.","examples":["pres_01"]},"first_name":{"type":"string","description":"The customer first name.","examples":["George"]},"last_name":{"type":"string","description":"The customer last name.","examples":["Washington"]},"email":{"type":"string","description":"Available customer email text, including historical values.","examples":["georgew@whitehouse.gov"]},"phone":{"type":"string","description":"Available customer phone number, using its international form when available.","examples":["1234567890"]},"company":{"type":"string","description":"The customer company.","examples":["Acme Inc."]},"address_line_1":{"type":"string","description":"The customer first address line.","examples":["1600 Pennsylvania Ave"]},"address_line_2":{"type":"string","description":"The customer second address line.","examples":["West Wing"]},"city":{"type":"string","description":"The customer city.","examples":["Washington"]},"state":{"type":"string","description":"The customer state.","examples":["DC"]},"zip":{"type":"string","description":"The customer ZIP and or postal code.","examples":["20500"]},"country":{"type":"string","description":"Recognized uppercase ISO 3166-1 alpha-3 country code; omitted when unavailable or unrecognized.","minLength":3,"maxLength":3,"examples":["USA"]},"enabled":{"type":"boolean","description":"Whether the customer is enabled."},"blocked":{"type":"boolean","description":"Whether the customer is blocked.","examples":[false]},"metadata":{"items":{"type":"object","description":"A metadata entry.","additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100,"examples":["website"]},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255,"examples":["mystore.com"]}}},"type":"array","description":"Up to the first 50 valid metadata name/value pairs, preserving text, order and duplicates.","maxItems":50},"status":{"type":"string","description":"Customer status, independently of subscription status: Chargeback precedes Fraud Detected, Blocked, Disabled and Enabled.","enum":["Enabled","Disabled","Blocked","Fraud Detected","Chargeback"],"examples":["Enabled"]}}},"payment_type":{"type":["object","null"],"description":"Recognized ID/name pair for Credit Card, PayPal, Offline Payment or Check; null when unavailable or unrecognized.","additionalProperties":false,"properties":{"id":{"type":"string","enum":["KnQ0KlNE6kf5mobyV0pN","ALkMK9pqgzfvgrqjlMVL","1rdzjX2rrkcNjPXMEvOm","vEZoAZrZL4S6WG4Ryzo1"],"description":"20 character RevCent ID corresponding to the payment type name.","examples":["KnQ0KlNE6kf5mobyV0pN","ALkMK9pqgzfvgrqjlMVL","1rdzjX2rrkcNjPXMEvOm","vEZoAZrZL4S6WG4Ryzo1"]},"name":{"type":"string","enum":["Credit Card","PayPal","Offline Payment","Check"],"description":"Name corresponding to the payment type ID.","examples":["Credit Card","PayPal","Offline Payment","Check"]}}},"third_party_shop":{"description":"Available associated User Shop ID/name summary, or null.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the user shop.","type":"string","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]},"name":{"description":"The user shop name.","type":"string","examples":["My Store"]}},"type":["object","null"]},"product":{"type":"object","description":"Required available product summary. Purchase quantities and prices may be omitted when unavailable; product-sale information is not required for the subscription to be returned.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the product.","title":"Product ID","type":"string","minLength":20,"maxLength":20,"examples":["6r8O5MLbw2t6n4v1lGqK","r1Ebz4d6qaH05LPvWM1M"]},"name":{"type":"string","description":"The product name.","examples":["AV 2017"]},"internal_id":{"type":"string","description":"The consumer's own product reference, when available.","examples":["av_2017101"]},"sku":{"type":"string","description":"The product SKU.","examples":["av_2017"]},"price":{"description":"Available purchase price in major currency units, retaining its numeric precision; omitted when unavailable or invalid.","type":"number","format":"float","examples":[49.99]},"quantity":{"description":"Available historical safe-integer product quantity, including zero and negative values; omitted when invalid.","type":"integer","examples":[1]},"is_subscription":{"type":"boolean","description":"Whether the product is a subscription product.","examples":[true]},"is_trial":{"type":"boolean","description":"Whether the product is a trial product.","examples":[false]},"list_price":{"type":"number","description":"Available list price for the purchase in major currency units, retaining its numeric precision; omitted when unavailable or invalid.","examples":[0]},"is_shippable":{"type":"boolean","description":"Whether the product is shippable."}}},"billing":{"type":"object","description":"Billing information with independently nullable dates, last-renewal identity and amount. Availability does not guarantee a future successful payment.","additionalProperties":false,"properties":{"next_renewal_date_unix":{"description":"Available next renewal time in Unix seconds; null when expired, occurrence-blocked or the date is unavailable or unusable.","type":["integer","null"],"format":"unix-time","examples":[1713892753]},"last_renewal_date_unix":{"description":"Available linked last-renewal creation time in Unix seconds; null when the renewal identity or date is unavailable or unusable.","type":["integer","null"],"format":"unix-time","examples":[1706030353]},"last_renewal_id":{"description":"Linked last renewal's 20 character RevCent ID for GetSubscriptionRenewal; null when unavailable. This link does not guarantee global recency.","type":["string","null"],"minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"last_renewal_amount":{"type":["number","null"],"description":"Linked last renewal's total in that renewal's currency, matching GetSubscriptionRenewal.amount and amount_total with two-decimal rounding. Missing/null totals return zero for an available renewal; invalid totals or an unavailable renewal return null. Retrieve the renewal for its available currency; do not infer it from this amount.","examples":[0]}}},"subscription_profile":{"type":"object","description":"Available subscription schedule summary. Historical settings are preserved; optional text/numbers can be omitted, and frequency_unit, frequency_value and occurrences_value may be null.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the subscription profile.","type":"string","minLength":20,"maxLength":20,"examples":["r1E1mnl41afb8La0mjMw","4R5RMnpA8ZSMMjEV2a21"]},"name":{"description":"Subscription profile name","type":"string","examples":["Monthly"]},"description":{"description":"Subscription profile description.","type":"string","examples":["My sub profile."]},"occurrences":{"description":"Saved occurrence setting. Indefinite does not impose an occurrence limit; other settings require a usable nonnegative whole-number occurrences_value.","type":"string","examples":["indefinite","specific"]},"occurrences_value":{"description":"Saved renewal occurrence limit, or null. Zero blocks further occurrences; invalid/unavailable finite-limit settings yield Occurrence Error. Historical whole numbers are returned without rounding.","type":["integer","null"],"examples":[2]},"frequency_unit":{"type":["string","null"],"description":"Available interval unit, such as days or months; historical text and null are preserved.","examples":["months"]},"frequency_value":{"type":["number","null"],"description":"Available interval value used with frequency_unit; finite historical precision and null are preserved.","examples":[3]}}},"sales":{"items":{"description":"20 character RevCent ID of the related sale.","type":"string","minLength":20,"maxLength":20,"examples":["k6vnbJom00Ug89mpRj78"]},"type":"array","description":"Up to ten distinct available related sale IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"product_sales":{"items":{"description":"20 character RevCent ID of the related product sale.","type":"string","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hbPzpBn8aY"]},"type":"array","description":"Up to ten distinct available related product sale IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"trials":{"items":{"description":"20 character RevCent ID of the related trial.","type":"string","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hb6o2Pvl5j"]},"type":"array","description":"Up to ten distinct available related trial IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"subscription_renewals":{"items":{"description":"20 character RevCent ID of the related subscription renewal.","type":"string","minLength":20,"maxLength":20,"examples":["YaVqjA1JowiGpyEN0o55"]},"type":"array","description":"Up to ten distinct available related subscription renewal IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist. Selected by renewal creation time, newest first within the returned subset.","maxItems":10,"uniqueItems":true},"transactions":{"items":{"description":"20 character RevCent ID of the related transaction.","type":"string","minLength":20,"maxLength":20,"examples":["d9ZoKG0n2pIwBG60Q6aW"]},"type":"array","description":"Up to ten distinct available related transaction IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist. Includes available transaction links from the selected renewals, preserving association order.","maxItems":10,"uniqueItems":true},"salvage_transactions":{"items":{"description":"20 character RevCent ID of the related salvage transaction.","type":"string","minLength":20,"maxLength":20,"examples":["VPm9Mqmgw7UJJLldojJY"]},"type":"array","description":"Up to ten distinct available related salvage transaction IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"is_expired":{"type":"boolean","description":"Available expiration flag; false when unavailable. This flag suppresses the next renewal date without independently rewriting the display status."},"expired_date_unix":{"type":["integer","null"],"description":"Available expiration time in Unix seconds when is_expired is true; otherwise null. Null also indicates an unavailable or unusable date.","format":"unix-time","examples":[1893499200]}}},"type":"array","maxItems":25,"description":"Available subscriptions in newest-first creation order; empty when no records match or the page is beyond the results."},"total_count":{"description":"Number of available subscriptions matching the date range and all applicable filters.","type":"integer","minimum":0,"examples":[28]},"total_pages":{"description":"Total_count divided by the required limit, rounded up; zero when no subscriptions match. May exceed the maximum requestable page of 20.","type":"integer","minimum":0,"examples":[3]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions/{subscription_id}":{"get":{"summary":"Get A Subscription","description":"Retrieve one subscription, including lifecycle status, billing information, product details and renewal schedules.","operationId":"GetSubscription","x-api-permission-description":"Allows the retrieving of subscriptions.","x-api-permission":"subscription:retrieve","x-ai-options":["ai_assistant","ai_voice_agent","mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/GetSubscription.md","x-ai-q":"Tell me how subscriptions work in RevCent and how they can help my ecommerce business manage recurring revenue effectively.","tags":["Subscriptions"],"parameters":[{"in":"path","name":"subscription_id","description":"20 character RevCent ID of the subscription to retrieve, available from GetSubscriptions. This operation accepts no query parameters.","required":true,"schema":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","description":"Subscription details and available related resources.","additionalProperties":false,"properties":{"api_call_id":{"description":"20 character RevCent ID of this API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp in seconds when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"A value of 1 indicates successful retrieval, not a successful subscription payment.","type":"integer","enum":[1],"examples":[1]},"id":{"description":"The requested subscription's 20 character RevCent ID.","type":"string","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"created_date_unix":{"description":"Subscription creation time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"updated_date_unix":{"description":"Subscription update time in Unix seconds.","type":"integer","format":"unix-time","examples":[1675367500]},"amount":{"description":"Subscription amount in major units of iso_currency, rounded to two decimals. Historical signed values are retained; unavailable or invalid values are omitted.","type":"number","format":"float","examples":[49.99]},"iso_currency":{"description":"Recognized three-letter ISO 4217 currency code, preserving saved case. Omitted when unavailable or unrecognized; no USD or other currency is assumed.","type":"string","examples":["USD"],"minLength":3,"maxLength":3},"live_mode":{"description":"Whether the subscription is in live mode rather than test mode; omitted when unavailable.","type":"boolean","examples":[true]},"campaign_id":{"description":"Available campaign's 20 character RevCent ID, returned with campaign_name.","type":"string","title":"Campaign ID","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"Available campaign name, returned with campaign_id.","examples":["AdWords Campaign"]},"is_active":{"description":"Available active flag, independently of display status. True when not provided; invalid nonboolean values are omitted.","type":"boolean","examples":[true]},"num_overdue":{"description":"Available overdue count; zero when not provided. Historical whole-number values are retained; invalid values are omitted.","type":"integer","examples":[0]},"has_replacement":{"description":"Available flag that a replacement exists; false when not provided. Its identity can still be unavailable.","type":"boolean","examples":[false]},"is_replacement":{"description":"Available flag that this subscription replaces an earlier subscription; false when not provided.","type":"boolean","examples":[false]},"is_suspended":{"description":"Available suspended flag, independently of display status. False when not provided; invalid nonboolean values are omitted.","type":"boolean","examples":[false]},"is_cancelled":{"description":"Available cancelled flag, independently of display status. False when not provided; invalid nonboolean values are omitted.","type":"boolean","examples":[false]},"is_overdue":{"description":"Available overdue flag, independently of display status. False when not provided; invalid nonboolean values are omitted.","type":"boolean","examples":[false]},"is_occurrence_limit":{"description":"Whether the occurrence limit or an unusable occurrence setting blocks further renewals. The renewal history used for this flag is not limited to the returned subscription_renewals IDs.","type":"boolean","examples":[false]},"status":{"description":"Subscription display status, separate from customer status and lifecycle flags. Values include Active, Trial, Occurrence Limit, Occurrence Error, Fraud Detected and Chargeback; historical text is also returned. Error is returned when status text is unavailable.","type":"string","examples":["Active","Overdue","Suspended","Cancelled","Occurrence Limit","Replaced"]},"subscription_start_date_unix":{"description":"Available subscription start time in Unix seconds, or null when unavailable or unusable.","type":["integer","null"],"format":"unix-time","examples":[1706030353]},"subscription_replaced":{"description":"The earlier subscription that this subscription replaces: a 20 character RevCent ID string, or null when unavailable.","type":["string","null"],"minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"subscription_replaced_with":{"description":"The replacement subscription that supersedes this subscription: a 20 character RevCent ID string, or null when unavailable.","type":["string","null"],"minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"future_renewal_dates":{"description":"Up to three available planned renewal times in Unix seconds. These dates can coexist with expiration or Fraud Detected/Chargeback display status and do not guarantee future charges.","type":"array","items":{"type":"integer","format":"unix-time","examples":[1706030353]},"maxItems":3},"metadata":{"items":{"type":"object","description":"A metadata entry.","additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100,"examples":["website"]},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255,"examples":["mystore.com"]}}},"type":"array","description":"Up to the first 50 valid metadata name/value pairs, preserving text, order and duplicates; not necessarily the complete collection.","maxItems":50},"ship_to":{"type":["object","null"],"description":"Available delivery address, or null when unavailable. Individual unavailable or invalid fields are omitted; historical email text is retained.","additionalProperties":false,"properties":{"first_name":{"type":"string","description":"The shipping first name.","examples":["George"]},"last_name":{"type":"string","description":"The shipping last name.","examples":["Washington"]},"address_line_1":{"type":"string","description":"The shipping first address line.","examples":["1600 Pennsylvania Ave"]},"address_line_2":{"type":"string","description":"The shipping second address line.","examples":["West Wing"]},"city":{"type":"string","description":"The shipping city.","examples":["Washington"]},"state":{"type":"string","description":"The shipping state.","examples":["DC"]},"zip":{"type":"string","description":"The shipping ZIP and or postal code.","examples":["20500"]},"company":{"type":"string","description":"The shipping company.","examples":["Acme Inc."]},"country":{"type":"string","description":"Recognized uppercase ISO 3166-1 alpha-3 country code; omitted when unavailable or unrecognized.","minLength":3,"maxLength":3,"examples":["USA"]},"email":{"type":"string","description":"Available email text, including historical values.","examples":["georgew@whitehouse.gov"]},"phone":{"type":"string","description":"The shipping phone.","examples":["1234567890"]}}},"customer":{"type":"object","description":"Available customer summary, omitted when unavailable or unusable. Optional historical text is preserved.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the customer.","title":"Customer ID","type":"string","minLength":20,"maxLength":20,"examples":["4r158EzJmmcVM69dNLkg"]},"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time","examples":[1675367500]},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time","examples":[1675367500]},"internal_id":{"type":"string","description":"The consumer's own customer reference, when available.","examples":["pres_01"]},"first_name":{"type":"string","description":"The customer first name.","examples":["George"]},"last_name":{"type":"string","description":"The customer last name.","examples":["Washington"]},"email":{"type":"string","description":"Available email text, including historical values.","examples":["georgew@whitehouse.gov"]},"phone":{"type":"string","description":"Available customer phone number, using its international form when available.","examples":["1234567890"]},"company":{"type":"string","description":"The customer company.","examples":["Acme Inc."]},"address_line_1":{"type":"string","description":"The customer first address line.","examples":["1600 Pennsylvania Ave"]},"address_line_2":{"type":"string","description":"The customer second address line.","examples":["West Wing"]},"city":{"type":"string","description":"The customer city.","examples":["Washington"]},"state":{"type":"string","description":"The customer state.","examples":["DC"]},"zip":{"type":"string","description":"The customer ZIP and or postal code.","examples":["20500"]},"country":{"type":"string","description":"Recognized uppercase ISO 3166-1 alpha-3 country code; omitted when unavailable or unrecognized.","minLength":3,"maxLength":3,"examples":["USA"]},"enabled":{"type":"boolean","description":"Whether the customer is enabled."},"blocked":{"type":"boolean","description":"Whether the customer is blocked.","examples":[false]},"metadata":{"items":{"type":"object","description":"A metadata entry.","additionalProperties":false,"properties":{"name":{"type":"string","description":"A name paired to the value for the metadata object. Limited to 100 characters in length.","minLength":1,"maxLength":100,"examples":["website"]},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255,"examples":["mystore.com"]}}},"type":"array","description":"Up to the first 50 valid metadata name/value pairs, preserving text, order and duplicates; not necessarily the complete collection.","maxItems":50},"status":{"type":"string","description":"Customer status: Enabled, Disabled, Blocked, Fraud Detected or Chargeback. This describes the customer independently of the subscription status.","enum":["Enabled","Disabled","Blocked","Fraud Detected","Chargeback"],"examples":["Enabled"]}}},"payment_type":{"type":["object","null"],"description":"Recognized ID/name pair for Credit Card, PayPal, Offline Payment or Check; null when unavailable or unrecognized.","additionalProperties":false,"properties":{"id":{"type":"string","enum":["KnQ0KlNE6kf5mobyV0pN","ALkMK9pqgzfvgrqjlMVL","1rdzjX2rrkcNjPXMEvOm","vEZoAZrZL4S6WG4Ryzo1"],"description":"20 character RevCent ID corresponding to the payment type name.","examples":["KnQ0KlNE6kf5mobyV0pN","ALkMK9pqgzfvgrqjlMVL","1rdzjX2rrkcNjPXMEvOm","vEZoAZrZL4S6WG4Ryzo1"]},"name":{"type":"string","enum":["Credit Card","PayPal","Offline Payment","Check"],"description":"Name corresponding to the payment type ID.","examples":["Credit Card","PayPal","Offline Payment","Check"]}}},"third_party_shop":{"description":"Available associated User Shop ID/name summary; omitted when unavailable or unusable.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the user shop.","type":"string","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]},"name":{"description":"The user shop name.","type":"string","examples":["My Store"]}},"type":"object"},"product":{"type":"object","description":"Available product and purchased-product information. Optional amounts and text are omitted when unavailable or invalid; historical signed amounts and whole-number quantities are preserved.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the product.","title":"Product ID","type":"string","minLength":20,"maxLength":20,"examples":["6r8O5MLbw2t6n4v1lGqK","r1Ebz4d6qaH05LPvWM1M"]},"name":{"type":"string","description":"The product name.","examples":["AV 2017"]},"internal_id":{"type":"string","description":"The consumer's own product reference, when available.","examples":["av_2017101"]},"sku":{"type":"string","description":"The product SKU.","examples":["av_2017"]},"price":{"description":"Purchased unit price in major currency units, rounded to two decimals; not the extended quantity total.","type":"number","format":"float","examples":[49.99]},"quantity":{"description":"Available historical whole-number purchased quantity, including zero and negative values; omitted when invalid.","type":"integer","examples":[1]},"is_subscription":{"type":"boolean","description":"Whether the product is a subscription product.","examples":[true]},"is_trial":{"type":"boolean","description":"Whether the product is a trial product.","examples":[false]},"description":{"type":"string","description":"The product description.","examples":["Example description"]},"list_price":{"type":"number","description":"Available purchased product list price in major currency units, rounded to two decimals.","examples":[0]},"uuid":{"type":"string","description":"UUID identifying the purchased product, when available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"url":{"type":"string","description":"Product URL, when available.","examples":["https://example.com"]},"total_amount":{"type":"number","description":"Extended amount for the purchased quantity in major currency units, rounded to two decimals; omitted when the unit price, quantity or resulting total is invalid.","examples":[0]},"is_shippable":{"type":"boolean","description":"Whether the product is shippable."}}},"billing":{"type":"object","description":"Billing information with independently nullable dates, last-renewal identity and amount. Availability does not guarantee a successful future payment.","additionalProperties":false,"properties":{"next_renewal_date_unix":{"description":"Available next renewal time in Unix seconds; null when expired, occurrence-blocked or the date is unavailable or unusable.","type":["integer","null"],"format":"unix-time","examples":[1713892753]},"last_renewal_date_unix":{"description":"Available linked last-renewal creation time in Unix seconds; null when its identity or date is unavailable or unusable.","type":["integer","null"],"format":"unix-time","examples":[1706030353]},"last_renewal_id":{"description":"Linked last renewal's 20 character RevCent ID for GetSubscriptionRenewal, or null when unavailable. This link does not guarantee global recency.","type":["string","null"],"minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"last_renewal_amount":{"type":["number","null"],"description":"Linked last renewal's total in that renewal's currency, matching GetSubscriptionRenewal.amount and amount_total with two-decimal rounding. Missing/null totals return zero for an available renewal; invalid totals or an unavailable renewal return null. Retrieve the renewal for its available currency; do not infer its denomination from the subscription.","examples":[0]}}},"subscription_profile":{"type":"object","description":"Available subscription schedule configuration. Structured schedules may be null or partial; historical text and whole-number settings are preserved without implying current billing availability.","additionalProperties":false,"properties":{"id":{"description":"20 character RevCent ID of the subscription profile.","type":"string","minLength":20,"maxLength":20,"examples":["r1E1mnl41afb8La0mjMw","4R5RMnpA8ZSMMjEV2a21"]},"name":{"description":"Subscription profile name","type":"string","examples":["Monthly"]},"description":{"description":"Subscription profile description.","type":"string","examples":["My sub profile."]},"occurrences":{"description":"Occurrence setting: indefinite has no occurrence limit; other returned values use occurrences_value. Historical text is preserved.","type":"string","examples":["indefinite","specific"]},"occurrences_value":{"description":"Saved occurrence limit. Zero blocks further renewals; an invalid or unavailable finite-limit setting yields Occurrence Error. Historical whole numbers are returned without rounding.","type":"integer","examples":[2]},"subscription_specific":{"description":"Whether this is a custom subscription profile, independently of whether its associated subscription is available.","type":"boolean","examples":[false]},"subscription_id":{"type":["string","null"],"description":"Associated subscription's 20 character RevCent ID, or null when unavailable.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"frequency":{"description":"Schedule type, commonly unit, calendar or fiscal. Defaults to unit when not provided; historical text is preserved and invalid values are omitted.","type":"string","examples":["unit","calendar","fiscal"]},"frequency_unit":{"type":["object","null"],"description":"Unit schedule when frequency is unit; otherwise null. Individual unavailable settings are omitted.","additionalProperties":false,"properties":{"unit_value":{"description":"Whole-number interval in the accompanying unit; historical values are preserved.","type":"integer","examples":[3]},"unit":{"description":"Interval unit, such as days or months; historical text is preserved.","type":"string","examples":["months"]}}},"frequency_calendar":{"type":["object","null"],"description":"Available calendar schedule settings, or null. Settings can be partial even when another frequency is selected.","additionalProperties":false,"properties":{"calendar_value":{"type":"integer","description":"Whole-number calendar value used with calendar_unit and calendar_parent.","examples":[0]},"calendar_unit":{"type":"string","description":"Calendar unit for the renewal schedule.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"calendar_parent":{"type":"string","description":"Parent calendar interval for the schedule.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}},"frequency_fiscal":{"type":["object","null"],"description":"Available fiscal quarter/year schedule settings, or null. Settings can be partial even when another frequency is selected.","additionalProperties":false,"properties":{"fiscal_setting":{"type":"string","description":"Available fiscal timing setting.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"fiscal_value":{"type":"integer","description":"Available whole-number fiscal value; unavailable or invalid values are omitted.","examples":[0]},"fiscal_unit":{"type":"string","description":"Available fiscal interval unit, such as quarter or year.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}}}},"shipping":{"items":{"description":"20 character RevCent ID of the shipping.","type":"string","minLength":20,"maxLength":20,"examples":["gYamRbaGZphKn8zJVow1"]},"type":"array","description":"Currently returns an empty compatibility array. This does not establish that no shipping applies.","maxItems":0},"tax":{"items":{"description":"20 character RevCent ID of the tax.","type":"string","minLength":20,"maxLength":20,"examples":["MW5LoAVymnHww96XllEr"]},"type":"array","description":"Currently returns an empty compatibility array. This does not establish that no tax applies.","maxItems":0},"sales":{"items":{"description":"20 character RevCent ID of the related sale.","type":"string","minLength":20,"maxLength":20,"examples":["k6vnbJom00Ug89mpRj78"]},"type":"array","description":"Up to ten distinct available related sale IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"product_sales":{"items":{"description":"20 character RevCent ID of the related product sale.","type":"string","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hbPzpBn8aY"]},"type":"array","description":"Up to ten distinct available related product sale IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"trials":{"items":{"description":"20 character RevCent ID of the related trial.","type":"string","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hb6o2Pvl5j"]},"type":"array","description":"Up to ten distinct available related trial IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"subscription_renewals":{"items":{"description":"20 character RevCent ID of the related subscription renewal.","type":"string","minLength":20,"maxLength":20,"examples":["YaVqjA1JowiGpyEN0o55"]},"type":"array","description":"Up to ten distinct available related subscription renewal IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"transactions":{"items":{"description":"20 character RevCent ID of the related transaction.","type":"string","minLength":20,"maxLength":20,"examples":["d9ZoKG0n2pIwBG60Q6aW"]},"type":"array","description":"Up to ten distinct available related transaction IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"discounts":{"items":{"description":"20 character RevCent ID of the related discount.","type":"string","minLength":20,"maxLength":20,"examples":["5r1wN8EbAgsPvLlbMava"]},"type":"array","description":"Up to ten distinct available related discount IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"salvage_transactions":{"items":{"description":"20 character RevCent ID of the related salvage transaction.","type":"string","minLength":20,"maxLength":20,"examples":["VPm9Mqmgw7UJJLldojJY"]},"type":"array","description":"Up to ten distinct available related salvage transaction IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"paypal_transactions":{"items":{"description":"20 character RevCent ID of the related PayPal transaction.","type":"string","minLength":20,"maxLength":20,"examples":["k6omOdKbrRTZnpP6d7Ng"]},"type":"array","description":"Up to ten distinct available related PayPal transaction IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"offline_payments":{"items":{"description":"20 character RevCent ID of the related offline payment.","type":"string","minLength":20,"maxLength":20,"examples":["zGldyKJGORfkP1O1vJ4B"]},"type":"array","description":"Up to ten distinct available related offline payment IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"check_directs":{"items":{"description":"20 character RevCent ID of the related check payment.","type":"string","minLength":20,"maxLength":20,"examples":["GO51EXbbAPS6pP1Ov9kK"]},"type":"array","description":"Up to ten distinct available related check payment IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"chargebacks":{"items":{"description":"20 character RevCent ID of the related chargeback.","type":"string","minLength":20,"maxLength":20,"examples":["j0a9dNwVKqu8Qz5Vl6ZZ"]},"type":"array","description":"Up to ten distinct available related chargeback IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"fraud_detections":{"items":{"description":"20 character RevCent ID of the related fraud detection.","type":"string","minLength":20,"maxLength":20,"examples":["VPwOydX2ArHJy8gX2o98"]},"type":"array","description":"Up to ten distinct available related fraud detection IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"api_calls":{"items":{"description":"20 character RevCent ID of the related API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"type":"array","description":"Up to ten distinct available related API call IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"ai_assistants":{"items":{"description":"20 character RevCent ID of the related AI Assistant.","type":"string","title":"AI Assistant ID","minLength":20,"maxLength":20,"examples":["WgNQmKrM1LT9Jj4pAvk6"]},"type":"array","description":"Up to ten distinct available related AI Assistant IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true},"ai_threads":{"items":{"description":"20 character RevCent ID of the related AI Thread.","type":"string","title":"AI Thread ID","minLength":20,"maxLength":20,"examples":["V1q65avW45Spn1kbY9yV"]},"type":"array","description":"Up to ten distinct available related AI Thread IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist. Ordered by creation time, newest first within the selected subset; not necessarily the globally newest records.","maxItems":10,"uniqueItems":true},"ai_voice_agents":{"type":"array","description":"Up to ten distinct available related AI Voice Agent IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist.","maxItems":10,"uniqueItems":true,"items":{"type":"string","minLength":20,"maxLength":20,"description":"20 character RevCent ID of the related AI Voice Agent.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"ai_voice_calls":{"type":"array","description":"Up to ten distinct available related AI Voice Call IDs. This may be an incomplete subset; an empty array does not establish that no relationships exist. Ordered by creation time, newest first within the selected subset; not necessarily the globally newest records.","maxItems":10,"uniqueItems":true,"items":{"type":"string","minLength":20,"maxLength":20,"description":"20 character RevCent ID of the related AI Voice Call.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"is_expired":{"type":"boolean","description":"Available expiration flag; false when not provided. An expired subscription has no next renewal date, but can still include future renewal dates and a separate display status."},"expired_date_unix":{"type":["integer","null"],"description":"Available expiration time in Unix seconds when is_expired is true; otherwise null. Null also indicates an unavailable or unusable date.","format":"unix-time","examples":[1893499200]}}}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}},"post":{"summary":"Edit A Subscription","description":"Edit a subscription using the subscription ID. This operation is meant for modifying attributes of a subscription, and not the active status of a subscription. Use the web app to modify the product and customize a specific subscriptions' renewal period.","operationId":"EditSubscription","x-api-permission-description":"Allows the editing of subscriptions.","x-api-permission":"subscription:edit","x-ai-options":["ai_assistant","ai_voice_agent","mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/EditSubscription.md","tags":["Subscriptions"],"parameters":[{"in":"path","name":"subscription_id","description":"The subscription ID.","required":true,"schema":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"subscription_profile":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20,"examples":["r1E1mnl41afb8La0mjMw","4R5RMnpA8ZSMMjEV2a21"]},"coupon":{"description":"An array of coupons to attach to the subscription.","type":"array","items":{"type":"string","description":"A 20 character coupon ID.","minLength":20,"maxLength":20,"examples":["VPmmrpbVl7cQ9JaXEanl"]}},"amount":{"description":"The subscription amount in major currency units. Must be at least 0.01 whenever supplied. Accepted values are rounded to two decimal places using half-even rounding.","type":"number","minimum":0.01,"examples":[0.01]},"next_renewal_date":{"description":"Set the subscriptions' next renewal date","type":"string","format":"date-time","examples":["2030-12-31T12:00:00Z"]},"ship_to":{"description":"The ship to information for the item.","type":"object","additionalProperties":false,"properties":{"first_name":{"type":"string","description":"The shipping first name.","examples":["Alex"]},"last_name":{"type":"string","description":"The shipping last name.","examples":["River"]},"address_line_1":{"type":"string","description":"The shipping first address line.","examples":["123 Example Street"]},"address_line_2":{"type":"string","description":"The shipping second address line.","examples":["Suite 100"]},"city":{"type":"string","description":"The shipping city.","examples":["Boston"]},"state":{"type":"string","description":"The shipping state.","examples":["MA"]},"zip":{"type":"string","description":"The shipping ZIP and or postal code.","examples":["02108"]},"company":{"type":"string","description":"The shipping company.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"country":{"type":"string","description":"The address country as a valid three-letter ISO 3166-1 alpha-3 code, such as USA, MEX or CHN. If supplied and not empty, a valid three-letter code is required. Leading and trailing whitespace is removed and letters are normalized to uppercase. An empty string is allowed. Payment country codes are converted to the format required by the selected gateway. US, CA, MX and GB are also accepted and normalized to USA, CAN, MEX and GBR, respectively.","examples":["USA"]},"email":{"type":"string","format":"email","description":"The shipping email.","examples":["alex@example.com"]},"phone":{"type":"string","description":"The shipping phone.","examples":["+12025550123"]}}},"idempotency_key":{"type":"string","minLength":11,"maxLength":255,"description":"Optional unique key for this specific request. Use 11–255 characters, preferably ASCII. Reuse the same key only when retransmitting the same request after a timeout or lost response. A recognized duplicate returns HTTP 400 with error_code E0583 without executing again; the original response is not returned, and the duplicate error does not establish the operation outcome. Keys are scoped to your account and API credential, across operations. Use a new key for each deliberate new operation. A failed request can consume its key. Other lengths provide no duplicate protection. Keys are not permanent resource identifiers.","examples":["6f312ce2-7959-4c1b-a8dd-591fc5c789cf"]}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"campaign_id":{"description":"The 20 character ID of the campaign associated with the subscription.","type":"string","title":"Campaign ID","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"The name of the campaign associated with the subscription.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"anyOf":[{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]},{"type":"object","additionalProperties":false,"description":"Country validation failure.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E1146"],"examples":["E1146"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"path":{"type":"string","description":"Identifies the country value that could not be accepted.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions/{subscription_id}/activate":{"post":{"summary":"Activate A Subscription","description":"Activate a currently suspended subscription using the subscription ID.","operationId":"ActivateSubscription","x-api-permission-description":"Allows the activation of subscriptions.","x-api-permission":"subscription:activate","x-ai-options":["ai_assistant","ai_voice_agent","mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/ActivateSubscription.md","tags":["Subscriptions"],"parameters":[{"in":"path","name":"subscription_id","description":"The subscription ID.","required":true,"schema":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"result":{"type":"string","examples":["Subscription activated."]},"campaign_id":{"description":"The 20 character ID of the campaign associated with the subscription.","type":"string","title":"Campaign ID","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"The name of the campaign associated with the subscription.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"trial_id":{"anyOf":[{"type":"string","description":"A 20 character trial ID.","minLength":20,"maxLength":20,"examples":["LY5yop5nk7hb6o2Pvl5j"]},{"type":"null"}],"description":"The 20 character ID of the active trial expired by activation, or null when no active trial was expired."}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions/{subscription_id}/suspend":{"post":{"summary":"Suspend A Subscription","description":"Suspend a subscription using the subscription ID. You can restart a suspended subscription using the SubscriptionActivate operation.","operationId":"SuspendSubscription","x-api-permission-description":"Allows the suspension of subscriptions.","x-api-permission":"subscription:suspend","x-ai-options":["ai_assistant","ai_voice_agent","mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/SuspendSubscription.md","tags":["Subscriptions"],"parameters":[{"in":"path","name":"subscription_id","description":"The subscription ID.","required":true,"schema":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"result":{"type":"string","examples":["Subscription suspended."]},"campaign_id":{"description":"The 20 character ID of the campaign associated with the subscription.","type":"string","title":"Campaign ID","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"The name of the campaign associated with the subscription.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions/{subscription_id}/cancel":{"post":{"summary":"Cancel A Subscription","description":"Cancel a subscription using the subscription ID. This operation is permanent and cannot be undone. Use the SubscriptionSuspend operation if you wish to restart the subscription at a later date.","operationId":"CancelSubscription","x-api-permission-description":"Allows the cancellation of subscriptions.","x-api-permission":"subscription:cancel","x-ai-options":["ai_assistant","ai_voice_agent","mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/CancelSubscription.md","tags":["Subscriptions"],"parameters":[{"in":"path","name":"subscription_id","description":"The subscription ID.","required":true,"schema":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"result":{"type":"string","examples":["Subscription cancelled."]},"campaign_id":{"description":"The 20 character ID of the campaign associated with the subscription.","type":"string","title":"Campaign ID","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"The name of the campaign associated with the subscription.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions/{subscription_id}/renew":{"post":{"summary":"Renew A Subscription","description":"Renew a subscription and attempt payment immediately. Use update_schedule to control whether the next renewal date advances.","operationId":"RenewSubscription","x-api-permission-description":"Allows the renewal of subscriptions.","x-api-permission":"subscription:renew","x-ai-options":["ai_assistant","ai_voice_agent","mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/RenewSubscription.md","tags":["Subscriptions"],"parameters":[{"in":"path","name":"subscription_id","description":"The subscription ID.","required":true,"schema":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"number","minimum":0,"description":"Optional nonnegative renewal amount override in major currency units. Zero is allowed by the API, but the selected gateway may reject an amount below its own minimum, including zero.","examples":[0]},"gateway_id":{"type":"string","description":"Optional public account-owned user gateway ID. An ordinary-card override is exclusive and bypasses inherited profiles. A selected saved wallet always uses its originating gateway instead. No public payment_profile override.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"update_schedule":{"type":"boolean","default":true,"description":"Whether to advance the next renewal date when the renewal attempt begins, using the subscription frequency and manual renewal date. Defaults to true. The date advances even if payment is declined, rejected or uncertain. False preserves the existing date. Validation or eligibility failures before an attempt begins do not advance it."},"idempotency_key":{"type":"string","minLength":11,"maxLength":255,"description":"Optional unique key for this specific request. Use 11–255 characters, preferably ASCII. Reuse the same key only when retransmitting the same request after a timeout or lost response. A recognized duplicate returns HTTP 400 with error_code E0583 without executing again; the original response is not returned, and the duplicate error does not establish the operation outcome. Keys are scoped to your account and API credential, across operations. Use a new key for each deliberate new operation. A failed request can consume its key. Other lengths provide no duplicate protection. Keys are not permanent resource identifiers.","examples":["6f312ce2-7959-4c1b-a8dd-591fc5c789cf"]}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"The successful subscription renewal, including payment totals, related records and the resulting renewal schedule.","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"card_id":{"type":"string","description":"The 20 character RevCent ID of the selected card, or an empty string when no card ID is available. The field may be omitted when the payment outcome does not include a card reference.","anyOf":[{"minLength":20,"maxLength":20},{"const":""}],"examples":["aaaaaaaaaaaaaaaaaaaa"]},"payment_profile_results":{"type":"object","description":"Payment-profile results, when a payment profile was used.","additionalProperties":false,"properties":{"declined_transaction_array":{"type":"array","description":"IDs of declined transactions from this attempt.","items":{"type":"string","description":"A 20 character transaction ID.","minLength":20,"maxLength":20,"examples":["d9ZoKG0n2pIwBG60Q6aW"]}},"final_amount":{"type":"number","description":"The final amount evaluated by the payment profile.","examples":[0]},"num_declined_transactions":{"type":"integer","description":"The number of declined transactions.","examples":[0]},"original_amount":{"type":"number","description":"The amount before payment-profile adjustments.","examples":[0]},"payment_profile_id":{"type":"string","title":"Payment Profile ID","description":"A 20 character payment profile ID.","minLength":20,"maxLength":20,"examples":["Q48aAbVv21fJRvNKWrvP","AVjVVBr7QKF1ovd20w21"]},"payment_profile_name":{"type":"string","description":"The payment profile name.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_array":{"type":"array","description":"The payment-profile steps and their outcomes.","items":{"type":"object","description":"The result of one payment-profile step.","additionalProperties":false,"properties":{"kill_profile":{"type":"boolean","description":"Whether this step stopped the payment profile."},"kill_term":{"type":"string","description":"The configured response term that stopped the payment profile, when matched.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_action":{"type":"string","description":"The payment action for this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_amount":{"type":"number","description":"The payment amount for this step.","examples":[0]},"step_card":{"type":"string","minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of the card selected for this payment step. Omitted when no card ID is available; never null or an empty string.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_cascade_result":{"type":["object","null"],"description":"Gateway selection details for this step, when available. The fields depend on the configured routing method.","additionalProperties":true},"step_gateway":{"type":"string","description":"The gateway name for this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_gateway_id":{"type":"string","description":"The 20 character RevCent ID of the gateway for this step. An empty string is returned when no ID is available.","maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_gateway_response":{"type":"string","description":"The gateway result message.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_modifier":{"type":"string","description":"The configured amount modifier for this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_num":{"type":"integer","description":"The step number.","examples":[0]},"step_result":{"type":"string","description":"The step outcome.","enum":["Approved","Declined","Error"],"examples":["Approved"]},"step_setting":{"type":"string","description":"The setting used by this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_source":{"type":"string","description":"The routing source for this step.","enum":["cascade","flow","gateway"],"examples":["cascade"]},"step_transaction":{"type":["string","null"],"description":"The 20 character RevCent ID of the transaction for this step.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"swap_card":{"type":"boolean","description":"Whether this step selected a different card."}}}},"successful_gateway":{"type":["string","null"],"description":"The successful gateway, or null when there was no successful step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"successful_step_num":{"type":["number","null"],"description":"The successful step number, or null when there was no successful step.","examples":[0]}}},"amount":{"type":"number","description":"The amount captured for this payment. Expressed in the payment currency.","examples":[0]},"amount_captured":{"type":"number","description":"The amount captured. Expressed in the payment currency.","examples":[0]},"amount_discounted":{"type":"number","description":"The discount applied to this payment. Expressed in the payment currency.","examples":[0]},"amount_fees":{"type":"number","description":"The fees associated with this payment. Expressed in the payment currency.","examples":[0]},"amount_gross":{"type":"number","description":"The gross payment amount. Expressed in the payment currency.","examples":[0]},"amount_net":{"type":"number","description":"The net payment amount. Expressed in the payment currency.","examples":[0]},"amount_original_total":{"type":"number","description":"The original total before discounts and payment adjustments. Expressed in the payment currency.","examples":[0]},"amount_remaining":{"type":"number","description":"The unpaid amount assigned to recovery. Expressed in the payment currency.","examples":[0]},"amount_to_salvage":{"type":"number","description":"The amount assigned to the salvage transaction. Expressed in the payment currency.","examples":[0]},"campaign_id":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"customer_id":{"title":"Customer ID","type":"string","description":"A 20 character customer ID.","minLength":20,"maxLength":20,"examples":["4r158EzJmmcVM69dNLkg"]},"subscription_profile_id":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20,"examples":["r1E1mnl41afb8La0mjMw","4R5RMnpA8ZSMMjEV2a21"]},"subscription_renewal_id":{"type":"string","description":"A 20 character subscription renewal ID.","minLength":20,"maxLength":20,"examples":["YaVqjA1JowiGpyEN0o55"]},"campaign_name":{"type":"string","description":"The campaign name.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"gateway":{"type":"string","description":"The gateway name, when a payment attempt was made.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"gateway_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of the gateway, or null when no gateway ID is available. Included when a payment attempt was made.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"gateway_raw_response":{"type":["object","string"],"description":"The response returned by the gateway, as a JSON object or text.","additionalProperties":true},"transaction_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of the transaction, or null when no transaction was created.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"salvage_transaction":{"description":"The salvage transaction for the unpaid remainder, or null when none was created.","type":["object","null"],"additionalProperties":false,"properties":{"amount":{"type":"number","description":"The amount to recover.","examples":[0]},"enabled":{"type":"boolean","description":"Whether recovery is enabled."},"id":{"type":"string","description":"A 20 character salvage transaction ID.","minLength":20,"maxLength":20,"examples":["VPm9Mqmgw7UJJLldojJY"]},"sale_creator":{"type":"boolean","description":"Whether successful recovery creates a sale."}}},"salvage_transaction_created":{"type":"boolean","description":"Whether a salvage transaction was created for an unpaid remainder."},"discount_created":{"type":"array","description":"IDs of discount records created for this payment. An empty array means none were created.","items":{"type":"string","description":"A 20 character discount ID.","minLength":20,"maxLength":20,"examples":["5r1wN8EbAgsPvLlbMava"]}},"shipping_created":{"type":"array","description":"IDs of shipping records created for this payment. An empty array means none were created.","items":{"type":"string","description":"A 20 character shipping ID.","minLength":20,"maxLength":20,"examples":["gYamRbaGZphKn8zJVow1"]}},"tax_created":{"type":"array","description":"IDs of tax records created for this payment. An empty array means none were created.","items":{"type":"string","description":"A 20 character tax ID.","minLength":20,"maxLength":20,"examples":["MW5LoAVymnHww96XllEr"]}},"next_renewal_date":{"type":"string","description":"The next renewal date in M/D/YYYY format.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"next_renewal_date_unix":{"type":"integer","description":"The next renewal date as a Unix timestamp in seconds.","examples":[1893499200]},"schedule_updated":{"type":"boolean","description":"Whether the subscription renewal schedule was updated."}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"anyOf":[{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]},{"type":"object","additionalProperties":false,"description":"Country validation failure.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E1146"],"examples":["E1146"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"path":{"type":"string","description":"Identifies the country value that could not be accepted.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}},{"type":"object","additionalProperties":false,"description":"Validation failure identifying the affected customer.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0067","E0125","E0180","E0601"],"examples":["E0067"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"customer_id":{"type":"string","description":"The 20 character RevCent ID of the customer associated with this validation failure.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}},{"type":"object","additionalProperties":false,"description":"Payment-flow validation failure. Node and setting details are included when known.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0943","E0944","E0945","E0948","E0950"],"examples":["E0943"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"node_id":{"type":"string","description":"Identifies the affected payment-flow node when available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"invalid_setting":{"type":"string","description":"Identifies an invalid node setting when available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"explanation":{"type":"string","description":"Explains the invalid setting when available.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}}]}}}},"402":{"description":"Unsuccessful renewal attempt: code 2 indicates a confirmed failure or provider rejection; code 3 with reconciliation_required indicates an uncertain outcome. Either can include subscription_renewal_id.","content":{"application/json":{"schema":{"type":"object","description":"An unsuccessful subscription renewal attempt, including its renewal identifier, resulting schedule and any recovery transaction. A renewal identifier does not establish that payment was captured.","additionalProperties":false,"properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"code":{"type":"integer","description":"The renewal outcome: 2 for a confirmed unsuccessful attempt, including a known provider rejection; 3 when the payment outcome or completion is uncertain and requires reconciliation.","enum":[2,3],"examples":[2]},"message":{"type":"string","description":"A human-readable explanation of the unsuccessful payment.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"result":{"type":"string","description":"The payment outcome summary.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"campaign_id":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20,"examples":["mJ1zZoOobEuP8pnWKXd1"]},"campaign_name":{"type":"string","description":"The campaign name.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"customer_id":{"title":"Customer ID","type":"string","description":"A 20 character customer ID.","minLength":20,"maxLength":20,"examples":["4r158EzJmmcVM69dNLkg"]},"gateway":{"type":"string","description":"The gateway name, when an attempt reached a gateway.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"gateway_id":{"type":"string","description":"A 20 character user gateway ID.","minLength":20,"maxLength":20,"examples":["LYE26MW8Rlh5VbJmlp2l","bJmlp2LYE8Rlh5Vl26MW"]},"gateway_raw_response":{"type":["object","string"],"description":"The response returned by the gateway, as a JSON object or text.","additionalProperties":true},"custom_error":{"type":"string","description":"The payment-profile message supplied for a declined payment, when configured.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"payment_profile_results":{"type":"object","description":"Payment-profile results, when a payment profile was used.","additionalProperties":false,"properties":{"declined_transaction_array":{"type":"array","description":"IDs of declined transactions from this attempt.","items":{"type":"string","description":"A 20 character transaction ID.","minLength":20,"maxLength":20,"examples":["d9ZoKG0n2pIwBG60Q6aW"]}},"final_amount":{"type":"number","description":"The final amount evaluated by the payment profile.","examples":[0]},"num_declined_transactions":{"type":"integer","description":"The number of declined transactions.","examples":[0]},"original_amount":{"type":"number","description":"The amount before payment-profile adjustments.","examples":[0]},"payment_profile_id":{"type":"string","title":"Payment Profile ID","description":"A 20 character payment profile ID.","minLength":20,"maxLength":20,"examples":["Q48aAbVv21fJRvNKWrvP","AVjVVBr7QKF1ovd20w21"]},"payment_profile_name":{"type":"string","description":"The payment profile name.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_array":{"type":"array","description":"The payment-profile steps and their outcomes.","items":{"type":"object","description":"The result of one payment-profile step.","additionalProperties":false,"properties":{"kill_profile":{"type":"boolean","description":"Whether this step stopped the payment profile."},"kill_term":{"type":"string","description":"The configured response term that stopped the payment profile, when matched.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_action":{"type":"string","description":"The payment action for this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_amount":{"type":"number","description":"The payment amount for this step.","examples":[0]},"step_card":{"type":"string","minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of the card selected for this payment step. Omitted when no card ID is available; never null or an empty string.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_cascade_result":{"type":["object","null"],"description":"Gateway selection details for this step, when available. The fields depend on the configured routing method.","additionalProperties":true},"step_gateway":{"type":"string","description":"The gateway name for this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_gateway_id":{"type":"string","description":"The 20 character RevCent ID of the gateway for this step. An empty string is returned when no ID is available.","maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_gateway_response":{"type":"string","description":"The gateway result message.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_modifier":{"type":"string","description":"The configured amount modifier for this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_num":{"type":"integer","description":"The step number.","examples":[0]},"step_result":{"type":"string","description":"The step outcome.","enum":["Approved","Declined","Error"],"examples":["Approved"]},"step_setting":{"type":"string","description":"The setting used by this step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"step_source":{"type":"string","description":"The routing source for this step.","enum":["cascade","flow","gateway"],"examples":["cascade"]},"step_transaction":{"type":["string","null"],"description":"The 20 character RevCent ID of the transaction for this step.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"swap_card":{"type":"boolean","description":"Whether this step selected a different card."}}}},"successful_gateway":{"type":["string","null"],"description":"The successful gateway, or null when there was no successful step.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"successful_step_num":{"type":["number","null"],"description":"The successful step number, or null when there was no successful step.","examples":[0]}}},"reconciliation_required":{"type":"boolean","description":"Present and true when the payment outcome or completion is uncertain and requires reconciliation before another attempt. Omitted for a confirmed unsuccessful attempt."},"salvage_transaction":{"type":["object","null"],"description":"The salvage transaction created for this failure, or null when none was created.","additionalProperties":false,"properties":{"amount":{"type":"number","description":"The amount to recover.","examples":[0]},"enabled":{"type":"boolean","description":"Whether recovery is enabled."},"id":{"type":"string","description":"A 20 character salvage transaction ID.","minLength":20,"maxLength":20,"examples":["VPm9Mqmgw7UJJLldojJY"]},"sale_creator":{"type":"boolean","description":"Whether successful recovery creates a sale."}}},"salvage_transaction_created":{"type":"boolean","description":"Whether a salvage transaction was created for this failure."},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20,"examples":["WmPnWqPKbpFRmy6Ma2BG"]},"subscription_profile_id":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20,"examples":["r1E1mnl41afb8La0mjMw","4R5RMnpA8ZSMMjEV2a21"]},"subscription_renewal_id":{"description":"The 20 character RevCent ID of the renewal attempt. May be returned for a confirmed unsuccessful attempt or an uncertain outcome; its presence does not imply captured payment or uncertainty.","type":"string","minLength":20,"maxLength":20,"examples":["YaVqjA1JowiGpyEN0o55"]},"next_renewal_date":{"type":"string","description":"The next renewal date in M/D/YYYY format.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"next_renewal_date_unix":{"type":"integer","description":"The next renewal date as a Unix timestamp in seconds.","examples":[1893499200]},"schedule_updated":{"type":"boolean","description":"Whether the subscription renewal schedule was updated."}}}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/subscriptions/search":{"get":{"summary":"Search Subscriptions","description":"Find subscriptions by subscription ID, customer contact details or metadata values. Returns up to 10 matching summaries. Use a result ID with GetSubscription for fuller details when available.","operationId":"SearchSubscriptions","x-api-permission-description":"Allows the searching of subscriptions.","x-api-permission":"subscription:search","x-ai-options":["ai_assistant","mcp"],"x-additional-info":"Useful for finding a subscription when you do not know the subscription ID and wish to retrieve the details of a specific subscription. Once a subscription has been found, use an individual search results' id property and the GetSubscription operation to retrieve the subscription details.The T-Shirt is a great value for those needing a shirt during the hot summer months.
"]},"enabled":{"type":["boolean","string"],"description":"Remote purchase flag for a parent product, or an empty string when unavailable. Variation summaries return true even if their remote purchase flag is false or unavailable; this flag does not establish purchasability.","examples":[true]},"url":{"type":"string","description":"The URL to the product in the remote shop.","examples":["https://mystore.com/product/polo/"]},"image_url":{"type":"string","description":"The URL to the product image in the remote shop.","examples":["https://mystore.com/product/polo/image.jpg"]},"price":{"type":"string","description":"Remote price as numeric text, ordinarily with two decimal places; empty when unavailable. A variation with an explicitly empty price uses its parent’s price; a missing price remains empty. Currency is not provided.","examples":["19.99"]},"cost":{"type":["string","number"],"description":"Cost of the matched RevCent product, preserving numeric precision. Zero if the matched product has no available cost; an empty string if no match is available. Currency is not provided.","examples":[9.99]},"is_shippable":{"type":["boolean","string"],"description":"Remote shipping applicability, or an empty string when unavailable. Variations inherit their parent’s shipping applicability.","examples":[true]},"fulfillment_account":{"type":"string","description":"20 character RevCent ID of the associated fulfillment account, or an empty string when unavailable. See GetFulfillmentAccounts; refer to the product mutation operation for input requirements.","examples":["o1zXNj9RqztqbLKWGk4L"]},"third_party_shop":{"type":"string","description":"The requested account shop connection's 20 character RevCent ID.","examples":["o1zXNj9RqztqbLKWGk4L"]},"subscription_profile":{"type":"string","description":"20 character RevCent ID of the associated subscription profile, or an empty string when unavailable. See GetSubscriptionProfiles; refer to the product mutation operation for input requirements.","examples":["o1zXNj9RqztqbLKWGk4L"]},"trial_days":{"type":["string","number"],"description":"Positive trial duration in days from a matched RevCent product, preserving numeric precision; an empty string when unavailable.","examples":[30]},"parent_product":{"type":["string","number"],"description":"Parent product’s identifier in the remote shop, as a number or text; omitted when unavailable. Not a RevCent resource ID or a ready-to-submit RevCent parent-product selector.","examples":["1234"]},"google_product_category":{"type":"string","description":"Available saved Google product-category identifier text, or empty text. See the Google product taxonomy.","examples":["212"]},"metadata":{"type":"string","description":"Remote attribute name/value pairs encoded as a JSON array string, preserving text, order and duplicates. An empty string means attributes are unavailable; \"[]\" represents an available empty set. More than 1,000 source attributes causes a retrieval error.","examples":["[]"]},"msrp":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"is_price_sale":{"type":["boolean","string"],"description":"Remote sale-price flag for this product or variation, or an empty string when unavailable. Independent of enabled and in_stock.","examples":[true]},"price_sale":{"type":"string","description":"Remote sale price for this product or variation as numeric text, ordinarily with two decimal places; empty when unavailable. A variation does not inherit its parent’s sale price. Currency is not provided.","examples":["29.99"]},"is_discount":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"discount_rate":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"in_stock":{"type":["boolean","string"],"description":"Remote stock-availability flag for this product or variation, or an empty string when unavailable. Independent of enabled and is_price_sale.","examples":[true]},"stock":{"type":"string","description":"Available stock quantity represented as whole-count numeric text with decimal formatting, or empty text.","examples":["100.00"]},"brand":{"type":"string","description":"The product brand in the remote shop.","examples":["Gildan"]},"material":{"type":"string","description":"Available material text; custom when unavailable.","examples":["Cotton"]},"age_group":{"type":"string","description":"Compatibility label currently returned as adult; it does not verify product suitability.","examples":["adult"]},"condition":{"type":"string","description":"Compatibility label currently returned as new; it does not verify product condition.","examples":["new"]},"rating_value":{"type":"string","description":"Available remote rating value represented as numeric text, ordinarily with two decimal places; otherwise empty text.","examples":["4.5"]},"rating_count":{"type":"string","description":"Available rating count represented as whole-count numeric text with decimal formatting, or empty text. Distinct from rating_value.","examples":["100.00"]},"upc":{"type":"string","description":"Available remote global product identifier text, or empty text.","examples":["123456789012"]},"isbn":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"asin":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"mpn":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"ean":{"type":"string","description":"Compatibility field currently returned as an empty string.","examples":[""]},"weight":{"type":"string","description":"Available remote weight text, or empty text. This response does not specify or convert its unit.","examples":["1.5"]},"length":{"type":"string","description":"Available remote length text, or empty text. This response does not specify or convert its unit.","examples":["10.0"]},"width":{"type":"string","description":"Available remote width text, or empty text. This response does not specify or convert its unit.","examples":["5.0"]},"height":{"type":"string","description":"Available remote height text, or empty text. This response does not specify or convert its unit.","examples":["2.0"]},"date_last_updated_in_remote_shop":{"type":["string","null"],"description":"Available remote modification text, or null. Its timezone and format are not guaranteed; do not assume direct comparability with the RevCent timestamp.","examples":["2025-10-16T11:04:38"]},"date_last_updated_in_revcent":{"type":["string","null"],"description":"Available matched RevCent product update time, formatted as UTC YYYY-MM-DDTHH:mm:ss without a timezone suffix, or null. Does not by itself establish whether synchronization is needed.","examples":["2025-10-29T13:11:35"]},"third_party_shop_id":{"type":"string","minLength":20,"maxLength":20,"description":"The requested account shop connection's 20 character RevCent ID.","examples":["aaaaaaaaaaaaaaaaaaaa"]}}},"maxItems":10000},"shipping_methods":{"type":"array","description":"Available remote shipping methods, distinct from saved mappings. At most 10,000 entries. An unavailable, failed or oversized remote method response returns an empty array.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"Exact method identifier from the remote shop as text, not a RevCent resource ID.","type":"string","examples":["12"]},"name":{"description":"Method name from the remote shop; may be empty.","type":"string","examples":["Flat Rate"]},"description":{"description":"Remote description; may be empty or omitted when unavailable.","type":"string","examples":["Flat Rate Shipping"]},"enabled":{"description":"Whether the remote shop reports this method as enabled.","type":"boolean","examples":[true]}}},"maxItems":10000},"offline_payment_methods":{"type":"array","description":"Available remote alternate payment methods, distinct from saved mappings. At most 10,000 entries. An unavailable, failed or oversized remote method response returns an empty array.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"Exact method identifier from the remote shop as text, not a RevCent resource ID.","type":"string","examples":["34"]},"name":{"description":"Method name from the remote shop; may be empty.","type":"string","examples":["Sezzle"]},"method_title":{"description":"Remote display title; may be empty or omitted when unavailable.","type":"string","examples":["Sezzle Pay"]},"method_description":{"description":"Remote method description; may be empty or omitted when unavailable.","type":"string","examples":["Sezzle is a buy now pay later payment method."]},"description":{"description":"Remote description; may be empty or omitted when unavailable.","type":"string","examples":["Sezzle is a buy now pay later payment method."]},"enabled":{"description":"Whether the remote shop reports this method as enabled.","type":"boolean","examples":[true]}}},"maxItems":10000}}},"updated_date_unix":{"description":"Connection configuration update time in Unix seconds, omitted when unavailable.","type":"integer","format":"unix-time","examples":[1675367500]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}},"post":{"summary":"Edit A User Shop","description":"Edit a user shop in RevCent. Only provide the properties you wish to modify. Properties not provided will remain unchanged.","operationId":"EditUserShop","x-api-permission-description":"Allows the editing of third party shops.","x-api-permission":"user_shop:edit","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/EditUserShop.md","tags":["Shops"],"parameters":[{"in":"path","name":"user_shop_id","description":"The user shop ID.","required":true,"schema":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"description":"The user shop name. Must be unique from other user shop names.","type":"string","minLength":1,"examples":["Example"]},"description":{"description":"The third-party shop description. On edit, omission preserves it and an empty value clears it.","type":"string","examples":["Example description"]},"url":{"type":"string","description":"The shop URL.","examples":["https://example.com"]},"payment_profile_id":{"type":"string","description":"A 20 character payment profile ID to associate with the user shop. This determines the payment profile that will process credit card transactions.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"campaign_id":{"type":"string","description":"A 20 character campaign ID to associate with the user shop.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"site_shop_id":{"type":"string","description":"A 20 character site shop ID which is associated with the user shop.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"site_shop_version":{"type":"string","description":"The platform API version. Creation defaults to 3 for WooCommerce; editing preserves the saved version when omitted.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"offline_payment_methods":{"description":"An array of objects, each containing the name and possible third party integration for offline payment methods being used on the remote shop. Get the remote shop offline payment methods using the GetUserShop operation with the remote_data query parameter containing 'offline_payment_methods'. It is important to map offline payment methods being used in a remote shop to third party integration, where applicable. When editing a user shops' offline_payment_methods it is important to include all methods, as the array will be replaced in its entirety. If there are no offline payment methods, provide an empty array.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The remote shop id for the individual offline payment method. This should be the ID returned from the remote shop in the remote_data.offline_payment_methods[payment_method] when retrieving the remote shop offline payment methods using the GetUserShop operation with the remote_data query parameter containing 'offline_payment_methods'.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"name":{"description":"The name of the offline payment method. This should be the name returned from the remote shop in the remote_data.offline_payment_methods[payment_method] when retrieving the remote shop offline payment methods using the GetUserShop operation with the remote_data query parameter containing 'offline_payment_methods'.","type":"string","examples":["Example"]},"description":{"description":"The description of the offline payment method. This should be the description returned from the remote shop in the remote_data.offline_payment_methods[payment_method] when retrieving the remote shop offline payment methods using the GetUserShop operation with the remote_data query parameter containing 'offline_payment_methods'.","type":"string","examples":["Example description"]},"method_title":{"description":"The method title of the offline payment method. This should be the method_title returned from the remote shop in the remote_data.offline_payment_methods[payment_method] when retrieving the remote shop offline payment methods using the GetUserShop operation with the remote_data query parameter containing 'offline_payment_methods'.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"method_description":{"description":"The method description of the offline payment method. This should be the method_description returned from the remote shop in the remote_data.offline_payment_methods[payment_method] when retrieving the remote shop offline payment methods using the GetUserShop operation with the remote_data query parameter containing 'offline_payment_methods'.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"third_party_integration":{"description":"The public ID of an account-owned integration whose type is offline_payment. A valid integration is required for each submitted method.","type":"string","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]}},"required":["id","name","third_party_integration"]}},"shipping_methods":{"type":"array","description":"An array of objects, each containing the name of the shipping method being used on the remote shop. Get the remote shop shipping methods using the GetUserShop operation with the remote_data query parameter containing 'shipping_methods'. When editing a user shops' shipping_methods it is important to include all methods, as the array will be replaced in its entirety. If there are no shipping methods, provide an empty array.","items":{"type":"object","additionalProperties":false,"properties":{"third_party_shipping_id":{"description":"The remote shop id for the individual shipping method. This should be the third_party_shipping_id returned from the remote shop in the remote_data.shipping_methods[shipping_method] when retrieving the remote shop shipping methods using the GetUserShop operation with the remote_data query parameter containing 'shipping_methods'.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"third_party_shipping_name":{"description":"The third_party_shipping_name of the shipping method. This should be the third_party_shipping_name returned from the remote shop in the remote_data.shipping_methods[shipping_method]. Use this name to accurately map the provider property to a shipping provider within RevCent.","type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"provider":{"type":"string","description":"The shipping method provider in RevCent that is associated with this specific shipping method. Get a list of shipping providers via the GetShippingProviders operation. This must be a 20 character ID for a shipping provider in RevCent.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"provider_method":{"type":"string","description":"The shipping method in RevCent that is associated with this specific shop shipping method. Get a list of shipping methods for the related provider via the GetShippingProvider operation. This must be a 20 character ID for a shipping provider method in RevCent which is associated with the provider.","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"required":["third_party_shipping_id","third_party_shipping_name","provider","provider_method"]}},"fields":{"description":"Credential entries for the selected site shop. Each entry must contain a nonempty id and value. The API checks the entries against the selected shop configuration: every configured credential ID must appear exactly once, and duplicate or unknown IDs are rejected. An empty array is rejected when the selected configuration requires credentials. These configuration-dependent checks are performed by the API and are not expressed by this array schema. Alternatively, supply a completed secure_form_id, whose credentials take precedence. To replace credentials on edit, also send site_shop_id.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The id for the individual field according to the site shop fields required.","type":"string","minLength":1,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"value":{"description":"The value for the individual field according to the site shop fields required.","type":"string","minLength":1,"examples":["aaaaaaaaaaaaaaaaaaaa"]}},"required":["id","value"]}},"secure_form_id":{"type":"string","description":"A completed secure form ID. Create the form with CreateSecureForm, complete its form_url, and supply this ID to use the submitted credentials.","minLength":20,"maxLength":20,"examples":["aaaaaaaaaaaaaaaaaaaa"]},"enabled":{"type":"boolean","description":"Whether the third-party shop is enabled. Defaults to true on creation."},"live_mode":{"type":"boolean","description":"Whether the linked shop API account processes live operations. When supplying live_mode on edit, also supply another editable shop property, such as description or enabled. A request containing only live_mode is rejected, even if its value is unchanged."},"idempotency_key":{"type":"string","minLength":11,"maxLength":255,"description":"Optional unique key for this specific request. Use 11–255 characters, preferably ASCII. Reuse the same key only when retransmitting the same request after a timeout or lost response. A recognized duplicate returns HTTP 400 with error_code E0583 without executing again; the original response is not returned, and the duplicate error does not establish the operation outcome. Keys are scoped to your account and API credential, across operations. Use a new key for each deliberate new operation. A failed request can consume its key. Other lengths provide no duplicate protection. Keys are not permanent resource identifiers.","examples":["6f312ce2-7959-4c1b-a8dd-591fc5c789cf"]}},"type":"object","dependentRequired":{"fields":["site_shop_id"],"secure_form_id":["site_shop_id"]},"allOf":[{"if":{"required":["site_shop_id"]},"then":{"anyOf":[{"required":["fields"]},{"required":["secure_form_id"]}]}},{"if":{"required":["live_mode"]},"then":{"anyOf":[{"required":["name"]},{"required":["description"]},{"required":["url"]},{"required":["payment_profile_id"]},{"required":["campaign_id"]},{"required":["site_shop_id"]},{"required":["site_shop_version"]},{"required":["offline_payment_methods"]},{"required":["shipping_methods"]},{"required":["enabled"]}]}}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The third-party shop after creation or editing. Credentials are not returned. A successful save does not guarantee that remote installation checks or repairs succeeded. Use ValidateUserShop to check the installation.","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"api_call_region":{"type":"string","enum":["1","2","3"],"description":"The RevCent API region that completed the request.","examples":["1"]},"code":{"type":"integer","const":1,"examples":[1]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]},"name":{"type":"string","examples":["Example"]},"description":{"type":"string","examples":["Example description"]},"url":{"type":"string","examples":["https://example.com"]},"enabled":{"type":"boolean"},"is_hosted":{"type":"boolean"},"live_mode":{"type":"boolean"},"shop_version":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"created_date":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"updated_date":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time","examples":[1675367500]},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time","examples":[1675367500]},"fields_saved":{"type":"array","items":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]}},"api_account":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"name":{"type":"string","examples":["Example"]}}},"campaign":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"name":{"type":"string","examples":["Example"]}}},"webhook":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"name":{"type":"string","examples":["Example"]}}},"payment_profile":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"name":{"type":"string","examples":["Example"]}}},"site_shop":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"name":{"type":"string","examples":["Example"]},"description":{"type":"string","examples":["Example description"]},"version":{"type":"string","examples":["EC_v1"]},"fields":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"description":{"type":"string","examples":["Example description"]},"required":{"type":"boolean"}}}}}}}}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/user_shops/{user_shop_id}/validate":{"post":{"summary":"Validate A User Shop","description":"Checks the WooCommerce RevCent payment settings and required webhooks. Does not repair remote settings. Use FixUserShop to request repairs.","operationId":"ValidateUserShop","x-api-permission-description":"Allows the validation of third party shops.","x-api-permission":"user_shop:validate","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/ValidateUserShop.md","tags":["Shops"],"parameters":[{"in":"path","name":"user_shop_id","description":"The user shop ID.","required":true,"schema":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_region":{"type":"string","enum":["1","2","3"],"description":"The RevCent API region that completed the request.","examples":["1"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"anyOf":[{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]},{"type":"object","additionalProperties":false,"description":"Shop validation or repair could not verify the provider configuration.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0662","E0663"],"examples":["E0662"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"shop_response":{"type":"object","additionalProperties":true,"description":"Shop-provider response associated with the validation failure. Its fields depend on the provider."}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/user_shops/{user_shop_id}/fix":{"post":{"summary":"Fix A User Shop","description":"Checks a WooCommerce installation and repairs mismatched RevCent payment settings or webhooks. Performs at most two repair passes, verifying again after each. Missing or disabled plugins and connection failures are reported without repair.","operationId":"FixUserShop","x-api-permission-description":"Allows the fixing of third party shops.","x-api-permission":"user_shop:fix","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/FixUserShop.md","tags":["Shops"],"parameters":[{"in":"path","name":"user_shop_id","description":"The user shop ID.","required":true,"schema":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1],"examples":[1]},"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20,"examples":["y24rXwQPGNfdMAQbmpmG"]},"result":{"type":"string","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_region":{"type":"string","enum":["1","2","3"],"description":"The RevCent API region that completed the request.","examples":["1"]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"400":{"description":"Request or operation validation failed.","content":{"application/json":{"schema":{"anyOf":[{"description":"Ordinary validation errors or a malformed request rejected before API-call processing.","anyOf":[{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false},{"type":"object","additionalProperties":false,"description":"Request rejected before API-call processing. The API-call ID is null.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":[null]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0208"],"examples":["E0208"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"api_call_processed":{"type":"boolean","enum":[false],"description":"False when the request was rejected before API-call processing began.","examples":[false]},"valid_json":{"type":"boolean","enum":[false],"description":"False when the request body could not be accepted for processing.","examples":[false]}}}]},{"type":"object","additionalProperties":false,"description":"Shop validation or repair could not verify the provider configuration.","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"type":"string","enum":["E0662","E0663"],"examples":["E0662"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]},"shop_response":{"type":"object","additionalProperties":true,"description":"Shop-provider response associated with the validation failure. Its fields depend on the provider."}}}]}}}},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}},"/user_third_party_integrations":{"get":{"summary":"Get User Third Party Integrations","description":"Retrieve saved third-party integration configurations and their provider input definitions. Archived integrations are excluded; disabled integrations remain visible. This list does not retrieve remote choices.","operationId":"GetUserThirdPartyIntegrations","x-api-permission-description":"Allows the retrieval of user third party integrations.","x-api-permission":"user_third_party_integration:retrieve","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/GetUserThirdPartyIntegrations.md","tags":["Third Party Integrations"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of integrations per page. Defaults to 25. Values 1–100 are honored; larger positive integers reset the limit to 25. Supply this parameter once.","schema":{"type":"integer","minimum":1,"maximum":9007199254740991,"default":25,"examples":[25]},"style":"form"},{"name":"page","in":"query","required":false,"description":"Page number from 0 to 20. Defaults to 1; zero also selects page one. Supply this parameter once. Only limit and page query parameters are accepted.","schema":{"type":"integer","minimum":0,"maximum":20,"default":1,"examples":[1]},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Page of saved account integration configurations.","properties":{"api_call_id":{"description":"20 character RevCent ID of this API call.","type":"string","minLength":20,"maxLength":20,"examples":["KnBKryj7jOFPLW1pqkVM"]},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"1 means the integration configurations were retrieved successfully.","type":"integer","format":"int32","enum":[1],"examples":[1]},"current_count":{"description":"Number of integrations returned on this page. Unavailable entries may be omitted, so a short or empty result does not necessarily indicate the final page.","type":"integer","minimum":0,"maximum":100,"examples":[10]},"current_page":{"description":"Selected page number; omitted page and page zero both select page one.","type":"integer","minimum":1,"maximum":20,"examples":[1]},"results":{"items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The account integration's 20 character RevCent ID for GetUserThirdPartyIntegration.","type":"string","minLength":20,"maxLength":20,"examples":["8r4Er1PZglFWLblb7d8z","r1Ebz4d6qaH05LPvWM1M"]},"name":{"description":"Account integration name; may be empty.","type":"string","examples":["My OpenAI Account"]},"description":{"description":"Account integration description; may be empty or omitted when unavailable.","type":"string","examples":["The OpenAI integration for powering AI Assistants."]},"enabled":{"description":"Whether the integration is configured as enabled, when available. Disabled integrations remain in this list.","type":"boolean","examples":[true]},"third_party_credentials_saved":{"type":"array","description":"Keys identifying saved credential configurations, not credential values or RevCent resource IDs. Inclusion does not verify credential validity or connectivity. Order and duplicates are preserved. More than 1,000 entries causes a retrieval error.","items":{"type":"string","description":"Credential configuration key, not a RevCent resource ID.","examples":["aaaaaaaaaaaaaaaaaaaa"]},"maxItems":1000,"examples":["openai_api"]},"third_party_options_saved":{"type":"array","description":"Saved option groups and field values. Text, order and duplicates are preserved; saved values may differ from current choices. Each configuration array supports up to 1,000 entries; overflow causes a retrieval error.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Exact saved option-group configuration key, not a RevCent resource ID.","examples":["openai_model"]},"fields":{"type":"array","description":"Available saved option fields in configured order, including duplicates; malformed entries may be omitted.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Exact option-field configuration key, not a RevCent resource ID.","examples":["openai_model_selector"]},"value":{"type":"array","description":"Available saved text values in configured order, including duplicates and empty strings. Historical selections may differ from the current choices or selection settings.","items":{"type":"string","description":"One saved option value, including empty or historical text.","examples":["gpt-realtime-2"]},"maxItems":1000}}},"maxItems":1000}}},"maxItems":1000},"site_third_party_integration":{"type":"object","additionalProperties":false,"description":"Available provider definition and configuration inputs. This list does not retrieve remote choices or credential values.","properties":{"id":{"description":"The provider definition's 20 character RevCent ID for GetSiteThirdPartyIntegration, distinct from the account integration ID.","type":"string","minLength":20,"maxLength":20,"examples":["zGkz8XvX9yT48q6LRqjW","r1Ebz4d6qaH05LPvWM1M"]},"name":{"description":"Provider name; may be empty.","type":"string","examples":["OpenAI"]},"description":{"description":"Provider help text, when available; may be empty.","type":"string","examples":["The OpenAI API."]},"integration_type":{"description":"Provider purpose: ai for AI services, ai_voice for voice AI, offline_payment for alternate payments, shipping for shipment services, or tax for tax services.","type":"string","enum":["ai","ai_voice","offline_payment","tax","shipping"],"examples":["ai"]},"third_party_credentials":{"type":"object","description":"Credential input definitions, without credential values. Unavailable text is an empty string; unavailable fields are an empty array.","additionalProperties":false,"properties":{"id":{"description":"Exact credential-group configuration key, not a RevCent resource ID.","type":"string","examples":["openai_api"]},"name":{"description":"Available credential-group display label; empty when unavailable.","type":"string","examples":["OpenAI Credentials"]},"description":{"description":"Available credential-group help text; empty when unavailable.","type":"string","examples":["Your OpenAI credentials required for RevCent to connect."]},"fields":{"type":"array","description":"Credential field keys and labels, including partial definitions. Order and duplicates are preserved. More than 1,000 fields causes a retrieval error.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"Exact credential-field configuration key; empty when unavailable. Not a RevCent resource ID.","type":"string","examples":["api_key"]},"name":{"description":"Available credential-field display label; empty when unavailable.","type":"string","examples":["API Key"]},"required":{"type":"boolean","description":"Compatibility indicator returned as true. Refer to CreateUserThirdPartyIntegration or EditUserThirdPartyIntegration for submission requirements; this flag does not require resubmitting every field on each edit.","const":true,"examples":[true]}}},"maxItems":1000}}},"third_party_options":{"type":"array","description":"Option input definitions, in configured order with duplicate keys preserved. Each configuration array supports up to 1,000 entries; overflow causes a retrieval error.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"Exact option-group configuration key, not a RevCent resource ID.","type":"string","examples":["openai_model"]},"name":{"description":"Available option-group display label, including empty or historical text.","type":"string","examples":["Model"]},"description":{"description":"Available option-group help text, including empty or historical text.","type":"string","examples":["Select the OpenAI model to use for this integration."]},"required":{"type":"boolean","description":"Compatibility indicator returned as true. Refer to CreateUserThirdPartyIntegration or EditUserThirdPartyIntegration for submission requirements; this flag does not require resubmitting every field on each edit.","const":true,"examples":[true]},"fields":{"type":"array","description":"Available input or selector definitions for this group, preserving order and duplicate keys. Unusable definitions may be omitted.","items":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"Exact option-field configuration key; empty when unavailable. Not a RevCent resource ID.","type":"string","examples":["openai_model_selector"]},"name":{"description":"Available option-field label; empty when unavailable.","type":"string","examples":["OpenAI Model"]},"field_type":{"description":"input describes a text input; select describes a choice input. Saved historical values may differ from current choices.","type":"string","enum":["select","input"],"examples":["select","input"]},"required":{"type":"boolean","description":"Compatibility indicator returned as true. Refer to CreateUserThirdPartyIntegration or EditUserThirdPartyIntegration for submission requirements; this flag does not require resubmitting every field on each edit.","const":true,"examples":[true]},"select_settings":{"type":"object","description":"Available settings for a select input; omitted when unavailable.","additionalProperties":false,"properties":{"third_party_asset":{"type":"boolean","description":"Whether choices come from the provider. These choices are not retrieved in this list; use GetUserThirdPartyIntegration to request available remote choices.","examples":[true]},"options":{"type":"array","description":"Available static choices, preserving order, duplicates and empty strings. Always empty here for provider-supplied choices; use GetUserThirdPartyIntegration, subject to provider support and successful retrieval.","items":{"type":"string","examples":["gpt-realtime-2"]},"maxItems":1000},"multiple":{"type":"boolean","description":"Configured multiple-selection flag; false when unavailable. It does not rewrite or restrict the saved values returned here.","examples":[false]}}}}},"maxItems":1000}}},"maxItems":1000}}},"created_date_unix":{"description":"Integration creation time in Unix seconds, omitted when unavailable.","type":"integer","format":"unix-time","examples":[1675367500]},"updated_date_unix":{"description":"Integration configuration update time in Unix seconds, omitted when unavailable.","type":"integer","format":"unix-time","examples":[1675367500]}}},"type":"array","maxItems":100,"description":"Available integrations from the selected page, newest creation first with stable ordering for equal creation times. Unusable entries are omitted without replacement. Beyond-end pages are empty and retain matching totals."},"total_count":{"description":"Number of matching integrations, including entries unavailable in the returned results. May remain positive when results are empty.","type":"integer","minimum":0,"examples":[28]},"total_pages":{"description":"Matching total divided by the effective limit, rounded up. Zero when no integrations match. May exceed 20, although only pages 1–20 can be retrieved.","type":"integer","minimum":0,"examples":[3]}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":["string","null"],"minLength":20,"maxLength":20,"description":"The 20 character RevCent ID of this API call, or null if the request failed before an ID was available."},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time","examples":[1675367500]},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","examples":[0],"enum":[0]},"error_code":{"description":"The specific error code.","type":"string","examples":["E0001"]},"message":{"description":"A human readable description of the error.","type":"string","examples":["An API error occurred."]},"result":{"description":"A description of the API call result.","type":"string","examples":["Error"]}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}},"post":{"summary":"Create A User Third Party Integration","description":"Create a connection to a supported third-party integration. Some integrations require account-specific options after creation: retrieve them with GetUserThirdPartyIntegration, then submit them with EditUserThirdPartyIntegration.","operationId":"CreateUserThirdPartyIntegration","x-api-permission-description":"Allows the creation of user third party integrations.","x-api-permission":"user_third_party_integration:create","x-ai-options":["mcp"],"x-kb-link":"","x-kb-name":"","x-md-link":"markdown/mcp/operation/CreateUserThirdPartyIntegration.md","tags":["Third Party Integrations"],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"name":{"type":"string","description":"The User Third Party Integration name. Must be unique from other User Third Party Integration names.","examples":["Example"]},"description":{"type":"string","description":"The User Third Party Integration description.","examples":["Example description"]},"enabled":{"type":"boolean","description":"Whether the User Third Party Integration is enabled."},"site_third_party_integration":{"type":"string","description":"A 20 character site third party integration ID. Every user third party integration must have a site third party integration associated. Use the GetSiteThirdPartyIntegrations operation to retrieve the list of available site third party integrations and their corresponding IDs.