{"method":"GET","path":"https://api.revcent.com/v2/subscription_renewals/{subscription_renewal_id}","summary":"Get A Subscription Renewal","description":"Retrieve the details of a specific subscription renewal. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/GetSubscriptionRenewal.md for an in-depth overview of this operation.","operationId":"GetSubscriptionRenewal","parameters":[{"in":"path","name":"subscription_renewal_id","description":"The subscription_renewal ID.","required":true,"schema":{"type":"string","description":"A 20 character subscription renewal ID.","minLength":20,"maxLength":20}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"The API call response code, 1 = Success","type":"integer","enum":[1]}},"title":"APICallResponseInfo","type":"object","additionalProperties":false},{"allOf":[{"type":"object","additionalProperties":false,"properties":{"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20},"amount":{"description":"The subscription renewal amount.","type":"number","format":"float"},"amount_original_total":{"description":"The total calculated amount when an item is first created. I.e. the sum of all products, tax and shipping without discounts applied.","type":"number","format":"float"},"amount_total":{"description":"The current total amount after any refunds and discounts applied. amount_original_total - (amount_refunded + amount_discounted)","type":"number","format":"float"},"amount_gross":{"description":"The current gross amount, money actually transacted. payments - payments_refunded","type":"number","format":"float"},"amount_net":{"description":"The current net amount. amount_gross - amount_fees","type":"number","format":"float"},"amount_fees":{"description":"The current amount of calculated fees deducted by a payment processor. amount_gross * processor_fee_percentage","type":"number","format":"float"},"amount_captured":{"description":"The current amount captured but not yet settled.","type":"number","format":"float"},"amount_settled":{"description":"The current amount settled.","type":"number","format":"float"},"amount_remaining":{"description":"The current amount remaining to be processed. I.e. trials not yet expired or salvage transactions not yet salvaged. amount_to_salvage + awaiting_trial_expirations","type":"number","format":"float"},"amount_refunded":{"description":"The current amount of any refunds, including cancelled trial amounts.","type":"number","format":"float"},"campaign_id":{"type":"string","title":"Campaign ID","description":"A 20 character campaign ID.","minLength":20,"maxLength":20},"campaign_name":{"type":"string","description":"The campaign name."},"customer":{"type":"object","description":"The customer response object contains the details of the customer related to the item.","additionalProperties":false,"properties":{"address_line_1":{"type":"string","description":"The customer first address line."},"address_line_2":{"type":"string","description":"The customer second address line."},"blocked":{"type":"boolean","description":"Whether the customer is blocked."},"city":{"type":"string","description":"The customer city."},"company":{"type":"string","description":"The customer company."},"country":{"type":"string","description":"The customer country in three letter ISO 3166-1 alpha-3 format."},"email":{"type":"string","format":"email","description":"The customer email."},"first_name":{"type":"string","description":"The customer first name."},"internal_id":{"type":"string","description":"An internal ID given by the user for the customer."},"last_name":{"type":"string","description":"The customer last name."},"phone":{"type":"string","description":"The customer phone."},"state":{"type":"string","description":"The customer state."},"zip":{"type":"string","description":"The customer ZIP and or postal code."},"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"id":{"title":"Customer ID","type":"string","description":"A 20 character customer ID.","minLength":20,"maxLength":20},"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},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255}},"type":"object","required":["name","value"]},"type":"array","description":"An array of metadata objects, each metadata object being a name and value pair."},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}},"iso_currency":{"description":"The three digit ISO 4217 currency code.","type":"string","minLength":3,"maxLength":3},"live_mode":{"description":"Whether the item was created using a Live or Test API key.","type":"boolean"},"payment_type":{"title":"Payment Type Object","type":"object","additionalProperties":false,"description":"The item payment type object, consisting of the system payment type ID and name.","properties":{"id":{"oneOf":[{"title":"KnQ0KlNE6kf5mobyV0pN","type":"string","description":"The credit card payment type ID.","enum":["KnQ0KlNE6kf5mobyV0pN"]},{"title":"ALkMK9pqgzfvgrqjlMVL","type":"string","description":"The PayPal payment type ID.","enum":["ALkMK9pqgzfvgrqjlMVL"]},{"title":"1rdzjX2rrkcNjPXMEvOm","type":"string","description":"The offline payment type ID.","enum":["1rdzjX2rrkcNjPXMEvOm"]},{"title":"vEZoAZrZL4S6WG4Ryzo1","type":"string","description":"The check payment type ID.","enum":["vEZoAZrZL4S6WG4Ryzo1"]}]},"name":{"oneOf":[{"title":"Credit Card","type":"string","description":"The credit card payment type name.","enum":["Credit Card"]},{"title":"PayPal","type":"string","description":"The PayPal payment type name.","enum":["PayPal"]},{"title":"Offline Payment","type":"string","description":"The offline payment type name.","enum":["Offline Payment"]},{"title":"Check","type":"string","description":"The check payment type name.","enum":["Check"]}]}}},"product":{"additionalProperties":false,"properties":{"id":{"title":"Product ID","type":"string","description":"A 20 character product ID.","minLength":20,"maxLength":20},"name":{"type":"string","description":"The product name."},"quantity":{"description":"The quantity purchased specific to the product.","type":"integer"},"price":{"description":"The purchase price specific to the product.","type":"number","format":"float"},"is_subscription":{"type":"boolean","description":"Whether the product is a subscription product."},"is_trial":{"type":"boolean","description":"Whether the product is a trial product."},"internal_id":{"type":"string","description":"The product internal ID."},"sku":{"type":"string","description":"The product SKU."}},"type":"object"},"third_party_shop":{"description":"The originating user shop, if applicable.","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character user shop ID.","minLength":20,"maxLength":20},"name":{"description":"The user shop name.","type":"string"}},"type":"object"},"billing":{"description":"The current billing status for the subscription.","type":"object","additionalProperties":false,"properties":{"next_renewal_date_unix":{"description":"The next subscription renewal date.","type":"integer","format":"unix-time"},"last_renewal_date_unix":{"description":"The last subscription renewal date.","type":"integer","format":"unix-time"},"last_renewal_id":{"description":"The last subscription renewal ID.","type":"string","minLength":20,"maxLength":20}}},"is_overdue":{"description":"Whether the subscription renewal is currently overdue.","type":"boolean"},"ship_to":{"title":"Ship To Object","type":"object","additionalProperties":false,"description":"The ship to response object contains the details of the shipping destination related to the item.","properties":{"first_name":{"type":"string","description":"The shipping first name."},"last_name":{"type":"string","description":"The shipping last name."},"address_line_1":{"type":"string","description":"The shipping first address line."},"address_line_2":{"type":"string","description":"The shipping second address line."},"city":{"type":"string","description":"The shipping city."},"state":{"type":"string","description":"The shipping state."},"zip":{"type":"string","description":"The shipping ZIP and or postal code."},"company":{"type":"string","description":"The shipping company."},"country":{"type":"string","description":"The shipping country in three letter ISO 3166-1 alpha-3 format."},"email":{"type":"string","format":"email","description":"The shipping email."},"phone":{"type":"string","description":"The shipping phone."}}},"subscription_profile":{"description":"The subscription profile related to the item.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character subscription profile ID.","minLength":20,"maxLength":20},"name":{"description":"Subscription profile name","type":"string"},"description":{"description":"Subscription profile description.","type":"string"},"occurrences":{"description":"Whether there are a max number of renewals allowed.","type":"string","enum":["indefinite","specific"]},"occurrences_value":{"description":"If occurrences is specific, the max number of renewals until a subscription is ended.","type":"integer"},"subscription_specific":{"description":"Whether the subscription profile was made for a specific subscription. I.e. tailored to the customers' needs.","type":"boolean"},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20},"frequency_unit":{"description":"The unit frequency for the subscription profile.","type":"object","additionalProperties":false,"properties":{"unit_value":{"description":"The frequency value.","type":"integer"},"unit":{"description":"The frequency unit.","type":"string"}}},"frequency":{"description":"The type of frequency in which the subscription renews.","type":"string","enum":["unit","calendar","fiscal"]}}},"subscription_id":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20},"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},"value":{"type":"string","description":"A value paired to the name for the metadata object. Limited to 255 characters in length.","minLength":1,"maxLength":255}},"type":"object","required":["name","value"]},"type":"array","description":"An array of metadata objects, each metadata object being a name and value pair."},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}},{"properties":{"sales":{"items":{"type":"string","description":"A 20 character sale ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all sales related to the item, each item in the array being a sale_id. Retrieve the details of each sale_id using the GetSale operation."},"product_sales":{"items":{"type":"string","description":"A 20 character product sale ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all product sales related to the item, each item in the array being a product_sale_id. Retrieve the details of each product_sale_id using the GetProductSale operation."},"shipping":{"items":{"type":"string","description":"A 20 character shipping ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all shipments related to the item, each item in the array being a shipping_id. Retrieve the details of each shipping_id using the GetShipment operation."},"tax":{"items":{"type":"string","description":"A 20 character tax ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all tax related to the item, each item in the array being a tax_id. Retrieve the details of each tax_id using the GetTax operation."},"discounts":{"items":{"type":"string","description":"A 20 character discount ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all discounts related to the item, each item in the array being a discount_id. Retrieve the details of each discount_id using the GetDiscount operation."},"trials":{"items":{"type":"string","description":"A 20 character trial ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all trials related to the item, each item in the array being a trial_id. Retrieve the details of each trial_id using the GetTrial operation."},"subscriptions":{"items":{"type":"string","description":"A 20 character subscription ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all subscriptions related to the item, each item in the array being a subscription_id. Retrieve the details of each subscription_id using the GetSubscription operation."},"subscription_renewals":{"items":{"type":"string","description":"A 20 character subscription renewal ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all subscription renewals related to the item, each item in the array being a subscription_renewal_id. Retrieve the details of each subscription_renewal_id using the GetSubscriptionRenewal operation."},"invoices":{"items":{"type":"string","description":"A 20 character invoice ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all invoices related to the item, each item in the array being an invoice_id. Retrieve the details of each invoice_id using the GetInvoice operation."},"transactions":{"items":{"type":"string","description":"A 20 character transaction ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all credit card transactions related to the item, each item in the array being a transaction_id. Retrieve the details of each transaction_id using the GetTransaction operation."},"ai_threads":{"items":{"type":"string","title":"AI Thread ID","description":"A 20 character AI Thread ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all AI Threads related to the item, each item in the array being an ai_thread_id. Retrieve the details of each ai_thread_id using the GetAIThread operation."},"ai_assistants":{"items":{"type":"string","title":"AI Assistant ID","description":"A 20 character AI Assistant ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all AI Assistants related to the item, each item in the array being an ai_assistant_id. Retrieve the details of each ai_assistant_id using the GetAIAssistant operation."},"paypal_transactions":{"items":{"type":"string","description":"A 20 character PayPal transaction ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all PayPal transactions related to the item, each item in the array being a paypal_transaction_id. Retrieve the details of each paypal_transaction_id using the GetPayPalTransaction operation."},"offline_payments":{"items":{"type":"string","description":"A 20 character offline payment ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all offline payments related to the item, each item in the array being a offline_payment_id. Retrieve the details of each offline_payment_id using the GetOfflinePayment operation."},"check_directs":{"items":{"type":"string","description":"A 20 character check direct ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all checks related to the item, each item in the array being a check_direct_id. Retrieve the details of each check_direct_id using the GetCheckDirect operation."},"salvage_transactions":{"items":{"type":"string","description":"A 20 character salvage transaction ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all salvage transactions related to the item, each item in the array being a salvage_transaction_id. Retrieve the details of each salvage_transaction_id using the GetSalvageTransaction operation."},"pending_refunds":{"items":{"type":"string","description":"A 20 character pending refund ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all pending refunds related to the item, each item in the array being a pending_refund_id. Retrieve the details of each pending_refund_id using the GetPendingRefund operation."},"chargebacks":{"items":{"type":"string","description":"A 20 character chargeback ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all chargebacks related to the item, each item in the array being a chargeback_id. Retrieve the details of each chargeback_id using the GetChargeback operation."},"fraud_detections":{"items":{"type":"string","description":"A 20 character fraud detection ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all fraud detections related to the item, each item in the array being a fraud_detection_id. Retrieve the details of each fraud_detection_id using the GetFraudDetection operation."},"api_calls":{"items":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"type":"array","description":"An array containing the ID's of all API calls related to the item, each item in the array being an api_call_id. Retrieve the details of each api_call_id using the GetAPICall operation."}},"type":"object","additionalProperties":false}]}]}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}