# Void an order Voids a pending order with a specified ID. Endpoint: POST /orders/{id}/void Version: latest Security: SecretApiKey, JWT ## Security: - `SecretApiKey` (unknown) apiKey in header REB-APIKEY - `JWT` (unknown) http bearer JWT ## Path parameters: - `id` (string, required) ID of the resource. ## Response 201: - `201` (unknown) Order voided. ## Response 201 fields (application/json): - `id` (string) ID of the order. Example: ord_01HVKA5975PJBSQ1SX72G3MSZC - `type` (string, required) Type of the order. - `organizationId` (string) Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: org_0YVDM8RC7GDADADSBSMW124JA8 - `customerId` (string, required) ID of the customer resource. Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF - `websiteId` (string, required) ID of the website. A website is where an organization obtains a customer. For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG - `activationInvoiceId` (string) ID of the activation invoice. Example: in_0YVF9605RKC62BP14NE2R7V2XT - `recentInvoiceId` (string | null) ID of the most recently issued invoice. The invoice might not be `paid` yet. Example: in_0YVF9605RKC62BP14NE2R7V2XT - `status` (string) Status of the order. Enum: "pending", "active", "canceled", "churned", "paused", "voided", "completed", "trial-ended", "abandoned" - `inTrial` (boolean) Specifies if the subscription is currently in a trial period. - `trial` (object) Details of the trial. To use plan defaults, omit the `trial` key or set this value to `null`. - `trial.enabled` (boolean) Specifies if there is a trial for this subscription. Plans without trial prices are free trials. - `trial.endTime` (string | null) Time and date when the trial ends. If the order churns during the trial, this value is the time when the order churned. If a trial is enabled on this subscription, a value must be provided. If the specified trial end time is in the past, the current time is used. - `isTrialOnly` (boolean) Specifies if a subscription ends after a trial period. If this value is `true`, recurring settings are ignored. - `trialConversionTime` (string | null) Date and time when the subscription had a trial conversion. Trial conversion occurs when the first successful payment is made after a trial period. - `items` (array, required) Item in the order. - `items.id` (string) ID of the one-time sale. Example: ots_01HRF27SATGE4Z6PBJE6PD8328 - `items.type` (string, required) Specifies the type of order item. - `items.productId` (string) ID of the related product. Example: prod_0YV7DES3WPC5J8JD8QTVNZBZNZ - `items.plan` (any, required) Details of the plan. - `items.plan.id` (string, required) Unique resource ID. Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 - `items.plan.id` (string, required) ID of the plan. Example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X - `items.plan.type` (string) Variant of the plan. This field is optional in create and update requests. The variant is `one-time-sale` when both `recurringInterval` and `trial` are omitted. If included, this field must match the applicable variant. A mismatch results in an HTTP `422` response. Responses always include this field. Enum: "one-time-sale" - `items.plan.name` (string, required) Name of the plan. This name is displayed on invoices and receipts. - `items.plan.description` (string) Plain-text description of the plan. This field accepts plain-text only. - `items.plan.richDescription` (string) Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. - `items.plan.productId` (string, required) ID of the related product. Example: prod_0YV7DES3WPC5J8JD8QTVNZBZNZ - `items.plan.productOptions` (object | null) Name-value pairs that specify the product options. Example: {"color":"red","size":"xxl"} - `items.plan.currency` (string, required) Currency code in ISO 4217 format. Example: USD - `items.plan.currencySign` (string) Currency sign. - `items.plan.pricing` (object, required) Pricing details. - `items.plan.pricing.formula` (string, required) Price formula that determines which algorithm is used to calculate the invoice price based on the following factors: - Quantity in the order. This value may be variable if you are charging based on usage. If you are not charging based on usage, this value is determined when an order is created. - Price of the quantity range. Some formulas set a price based on defined product quantity ranges. For more information, see [Price formulas](https://www.rebilly.com/docs/billing/pricing-formulas/). Enum: "fixed-fee" - `items.plan.pricing.price` (number, required) Use this formula to charge for subscriptions that have a fixed price, number of units, and reoccur over a fixed period of time, such as every: day, week, month, year, or number of years. For example, a streaming company charges customers $13.99 each month for subscription period that is 6 months in duration. The quantity of movies that a customer streams each month does not impact the price. Example: 99.95 - `items.plan.pricing.price` (number, required) Use this formula to charge a flat fee per unit. For example, $0.10 for each transaction or $4 per unit. If the value of this field is `0`, the product is free. Example: 99.95 - `items.plan.pricing.minQuantity` (integer | null) Minimum permitted unit quantity. If this value is `null`, no limit is in place. Example: 1 - `items.plan.pricing.maxQuantity` (integer | null) Maximum permitted unit quantity. If this value is `null`, no limit is in place. Example: 1 - `items.plan.pricing.brackets` (array, required) Use this formula to charge for units that are sold in specific quantity ranges. For example, a bank charges a merchant based on the number of transactions they complete each month. | Price total | Max quantity | Description | | --- | --- | --- | | $50 | 1000 | Up to 1000 transactions | | $100 | 1500 | Between 1000 and 1500 transactions | | $200 | 3000 | Between 1500 and 3000 transactions | | $500 | null | More than 3000 transactions | - If the merchant completes 900 transaction in a month, they are charged $50. - If the merchant completes 1001 transaction in a month, they are charged $100. - If the merchant completes 2500 transaction in a month, they are charged $200. - If the merchant completes more than 3000 transaction in a month, they are charged $500. - `items.plan.pricing.brackets` (array, required) Use this formula to charge for units that are sold within defined quantity ranges, or tiers. If a customer buys a number of units that span more than one tier, the total cost is calculated based on the cost of the units in each tier. For example, a software company sells user licenses based on the following: | Tier | Price per user | Max quantity | Description | | --- | --- | --- | --- | | 1 | $40 | 3 | 1 to 3 user licenses | | 2 | $30 | 5 | 5 to 8 user licenses | | 3 | $15 | null | 9 or more user licenses | If a customer buys 10 user licenses, the pricing is as follows: - 3 licenses at tier 1 (3 x $40) is 120 - 5 licenses at tier 2 (5 x $30) is 150 - 2 licenses at tier 3 (2 x $15) is 30 Total cost = $330 Formula: `(price for the tier x quantity within the tier)` + `(price for next tier x quantity in next tier)` + `...` = final price. - `items.plan.pricing.brackets` (array, required) Use this formula to charge for units that are sold in bulk, or volume ranges. This formula enables customers to pays less per unit when they buy a large volume of units. Unit cost is based on the highest volume range, and does not include lower volume range pricing. For example, a company sells t-shirts in the following volume ranges: | Price per unit | Max quantity | Description | | --- | --- | --- | | $10 | 1 | 1 t-shirt | | $8 | 5 | 2 to 5 t-shirts | | $4 | null | 6 or more t-shirts | - If a customer buys 1 unit, they pay $10. - If a customer buys 3 units, they pay $24 per unit, which is $8 per unit. - If a customer buys 10 units, they pay $40, which is $4 per unit. - `items.plan.setup` (object | null) Setup fee information for the plan. - `items.plan.setup.price` (number, required) One-time setup fee charged when the plan starts. This field is deprecated. Use the `setupFee` field instead. - `items.plan.setupFee` (number | null) One-time setup fee charged when the plan starts. Set to `0` or `null` if no setup fee applies. Example: 0 - `items.plan.customFields` (object) Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields). Example: {"foo":"bar"} - `items.plan.isActive` (boolean) Specifies if the plan is active. - `items.plan.revision` (integer) Number of times the plan is modified. Compare this value with materialized subscription item revision values. - `items.plan.isTrialOnly` (boolean) Specifies if a plan is a trial that does not have recurring instructions. - `items.plan.recurringInterval` (null) Service interval settings. - `items.plan.trial` (null) Trial configuration setting. - `items.plan.createdTime` (string) Date and time when the resource is created. This value is set automatically when the resource is created. - `items.plan.updatedTime` (string) Date and time when the resource is updated. This value is set automatically when the resource is updated. - `items.plan._links` (array) Related links. - `items.plan._links.href` (string) Link URL. - `items.plan._links.rel` (string) Type of link. Enum: "self", "attachments" - `items.plan.type` (string) Variant of the plan. This field is optional in create and update requests. The variant is `subscription` when `recurringInterval` is present. If included, this field must match the applicable variant. A mismatch results in an HTTP `422` response. Responses always include this field. Enum: "subscription" - `items.plan.trial` (object | null) - `items.plan.trial.price` (number, required) Price of setting up a trial. If your service charges a fee for a trial, specify it here. To charge no trial fee, set this value to `0`. - `items.plan.trial.period` (object, required) Period information. - `items.plan.trial.period.unit` (string, required) Unit of time. Enum: "day", "week", "month", "year" - `items.plan.trial.period.length` (integer, required) Length of time. - `items.plan.meteredBilling` (object | null) Use metered billing when an exact quantity is unknown. Report usage during a service period and charge customers afterwards. Metered billing plans must be postpaid. - `items.plan.meteredBilling.strategy` (string, required) Enum: "sum", "last" - `items.plan.meteredBilling.min` (number | null) Minimum quantity that is charged at the end of a service period regardless of reported usage. - `items.plan.meteredBilling.max` (number | null) Maximum quantity that is charged at the end of a service period regardless of reported usage. - `items.plan.meteredBilling.sticky` (boolean) When enabled, if no usage is reported during a service period, the plan bills the last known reported quantity from a previous period instead of zero. This is suitable for hosted or persistent resources whose usage does not change every period. Only supported with `strategy`: `last`. Example: false - `items.plan.invoiceTimeShift` (object | null) Use invoice time shift to control the billing time. Invoice time shift adjusts the invoice issue and due date when billing must occur before the service period changes. Use invoice time shift in conjunction with `billingTiming` to: - Bill immediately when the service period starts. - Bill immediately after the service period ends. - Bill at an interval of time before the service period starts. - Bill at an interval of time after the service period starts. - Bill at an interval of time before the service period ends. - Bill at an interval of time after the service period ends. - `items.plan.invoiceTimeShift.issueTimeShift` (object) Calculation instruction of the billing time. This is used in conjunction with the service period anchor to calculate the time at which the invoice is issued. For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift). - `items.plan.invoiceTimeShift.issueTimeShift.chronology` (string, required) Sequential order of the billing time relative to the start of the service period. Enum: "before" - `items.plan.invoiceTimeShift.issueTimeShift.duration` (integer, required) Amount of time by which to move the invoice issue time or date. - `items.plan.invoiceTimeShift.issueTimeShift.unit` (any, required) Unit of time. - `items.plan.invoiceTimeShift.dueTimeShift` (object) Calculation instruction of the invoice due time. This is used in conjunction with the service period anchor to calculate when an invoice is due for payment. For more information, see [Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/subscriptions#service-period-anchor-billing-timing-and-invoice-time-shift). The sequential order of due time shift is always after the due date. - `items.plan.invoiceTimeShift.dueTimeShift.duration` (integer, required) Amount of time by which to move the invoice due time or date. - `items.plan.invoiceTimeShift.dueTimeShift.unit` (any, required) Unit of time. - `items.plan.type` (string) Variant of the plan. This field is optional in create and update requests. The variant is `trial-only` when `trial` is present without `recurringInterval`. If included, this field must match the applicable variant. A mismatch results in an HTTP `422` response. Responses always include this field. Enum: "trial-only" - `items.plan.trial` (object | null, required) Trial configuration settings. - `items.quantity` (integer) Number of product units in the specified plan. - `items.revision` (integer) Number of times the order data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. - `items.id` (string) ID of the subscription. Example: sub_01HRF27SATGE4Z6PBJE6PD8328 - `items.renewalReminderTime` (string | null) Date and time when the renewal reminder event triggers. - `items.renewalReminderNumber` (integer | null) Number of triggered renewal reminder events. - `items.recurringInterval` (object | null) Recurring interval to override plan settings. To use plan settings, set this value to `null`. To use multiple plans in one subscription, all plans must have the same recurring period length. Example: null - `items.recurringInterval.periodAnchorInstruction` (object | null) Instruction for calculating the service period anchor. The service period anchor is used, in conjunction with the subscription start time, to calculate when the service period starts and ends. - `items.recurringInterval.periodAnchorInstruction.method` (string, required) Enum: "day-of-month" - `items.recurringInterval.periodAnchorInstruction.day` (integer, required) Day of the month in which the event occurs. If the month has less days, the last day of the month is selected. - `items.recurringInterval.periodAnchorInstruction.time` (string) Extended ISO-8601 format of time. - `items.recurringInterval.periodAnchorInstruction.day` (string, required) Day of the week when the event occurs. Enum: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" - `items.recurringInterval.periodAnchorInstruction.week` (string, required) Enum: "next", "first-in-month", "last-in-month" - `items.recurringInterval.periodAnchorInstruction.month` (integer, required) Month of the year in which the event occurs. - `items.renewalTime` (string | null) Date and time when the subscription renews. - `items.currentPeriodStart` (string) Date and time of the current service period start. - `items.currentPeriodEnd` (string) Date and time of the current service period end. - `items.rebillNumber` (integer | null) Current billing period number. - `items.quantityFilled` (number | null) Number of filled product units. Example: 5.125 - `items.usageLimits` (any) - `items.usageLimits.softLimit` (object) Defines thresholds for notification purposes. For example, to notify the customer that their usage is near the hard limit of their metered billing plan. This notification informs the customer so that they can upgrade their plan before the hard limit is reached. When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered. The quantity limit applies to the larger of the reported and billed quantity. If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit. If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit. The amount limit applies to the billed amount. To notify the customer, a webhook and notification can be configured for this event. This field is useful for accounting and customer success purposes. The usage of metered billing plans can still be reported if the soft limit is reached. - `items.usageLimits.softLimit.quantity` (integer) Usage limit quantity. - `items.usageLimits.softLimit.amount` (number) Usage limit amount in the currency of the order. - `items.usageLimits.hardLimit` (object) Defines a limit where the customer can no longer use the service. Hard limits are used in addition to soft limits. When a soft limit is reached, a customer may receive a notification but the service can still be provided up to the hard limit value so that the customer can upgrade their plan. When the reported usage reaches the configured limit, a specific event is triggered. To notify the customer in the merchant system, or block a service, a webhook and notification can be configured for this event. When the total usage reaches the hard limit quantity, or amount values, metered billing plan usages can no longer be reported. Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount. A `quantity` value below the minimum billable quantity is invalid. An `amount` value below the minimum billable amount is invalid. A `0` value remains valid even on plans with minimum billing. - `items.usageLimits.hardLimit.quantity` (integer) Usage limit quantity. - `items.usageLimits.hardLimit.amount` (number) Usage limit amount in the currency of the order. - `items.usageLimits.trialLimit` (any) Defines a usage cap during the trial period of a subscription. This limit is enforced only while the subscription is in its trial phase. When the reported usage reaches the configured trial limit, an event called 'trial-usage-limit-reached' is triggered. To notify the customer or restrict access to the service, a webhook and notification can be configured for this event. Once the trial limit is reached, additional usage cannot be reported unless the trial ends. Example: 20.725 - `items.usageStatus` (any) - `items.usageStatus.isSoftLimitReached` (boolean) Specifies if the soft limit has been reached. Example: false - `items.usageStatus.isHardLimitReached` (boolean) Specifies if the hard limit has been reached. Example: false - `items.usageStatus.isTrialLimitReached` (boolean) Specifies if the trial limit has been reached. Example: false - `items.revision` (integer) Revision number that increments with each overriding change to this specific item. - `items.excludeFromMrr` (boolean) Specifies if this item should be excluded from monthly recurring revenue calculations. - `invoiceIssueTimeShift` (string) Invoice issue time shift interval in ISO-8601 format. This field adjusts the issue date and time of renewal invoices for the order. This interval value supports the `-` symbol. Example: +P00Y00M00DT00H00M00S - `invoiceDueTimeShift` (string) Invoice due time shift interval in ISO-8601 format. Use this field to adjust when payment is due for the order. If autopay is configured, payment is collected automatically on this date. This interval value supports the `+` symbol. Example: +P00Y00M00DT00H00M00S - `paymentInstrumentId` (string | null) ID of the payment instrument to use for autopay. If this value is not provided, or if the payment instrument is inactive, the customer's default payment instrument is used. Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N - `poNumber` (string | null) Purchase order number that is displayed on the issued invoices. Example: PO123456 - `notes` (string) Notes for the customer that are displayed on the order invoice. - `billingAddress` (any) Billing address of the order. Changes to the billing address apply to the upcoming invoice and to invoices created after the change. Issued invoices are not updated unless the order is `pending`. To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress). - `billingAddress.firstName` (string | null) Contact's first name. Example: Benjamin - `billingAddress.lastName` (string | null) Contact's last name. Example: Franklin - `billingAddress.organization` (string | null) Contact's organization. Example: Rebilly - `billingAddress.address` (string | null) First line of the contact's street address. Example: 36 Craven St - `billingAddress.address2` (string | null) Second line of the contact's street address. - `billingAddress.city` (string | null) Contact's city of residence. Example: Austin - `billingAddress.region` (string | null) Contact's region of residence. Example: Texas - `billingAddress.country` (string | null) Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). Example: GB - `billingAddress.postalCode` (string | null) Contact's postal code. Example: WC2N 5NF - `billingAddress.phoneNumbers` (array) List of phone numbers associated with the contact. - `billingAddress.phoneNumbers.label` (string, required) Phone number label or name. Example: main - `billingAddress.phoneNumbers.value` (string, required) Phone number value. Example: 1-512-777-0269 - `billingAddress.phoneNumbers.primary` (boolean) Specifies if the phone number is the contact's primary phone number. Example: true - `billingAddress.emails` (array) List of email addresses associated with the contact. - `billingAddress.emails.label` (string, required) Email label or name. Example: main - `billingAddress.emails.value` (string, required) Email address value. Example: rebilly@example.com - `billingAddress.emails.primary` (boolean) Specifies if the email address is the contact's primary email address. Example: true - `billingAddress.dob` (string | null) Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. Example: 1980-04-01 - `billingAddress.jobTitle` (string | null) Contact's job title. Example: CEO - `billingAddress.hash` (string) Hash value for the contact. Use this value to compare contacts for identical attribute values. Example: 056ae6d97c788b9e98b049ebafd7b229bf852221 - `deliveryAddress` (any) Delivery address of the order. Changes to the delivery address apply to the upcoming invoice and to invoices created after the change. Issued invoices are not updated unless the order is `pending`. To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress). - `delinquencyPeriod` (string | null) Length of time, in ISO-8601 durations format, which is added to the due time of the order when setting the delinquency time for all related invoices. When the delinquency time of an invoice is reached, the order is automatically canceled. If the provided value is `null`, the order does not change state. Example: +P00Y00M07DT00H00M00S - `riskMetadata` (any) Risk metadata. If this value is `null`, this field uses risk metadata that is captured when creating the payment token. - `riskMetadata.ipAddress` (string | null) Customer's IP address. Example: 93.92.91.90 - `riskMetadata.fingerprint` (string | null) Customer's device fingerprint. A device fingerprint is a unique token that is used to identify the customer. The device fingerprint is generated based on device attributes, such as: hardware, software, IP address, language, browser, and more. Example: pIUt3xbgX3l9g3YDiLbx - `riskMetadata.httpHeaders` (any) - `riskMetadata.browserData` (object | null) Browser data used for 3D Secure and risk scoring. - `riskMetadata.browserData.colorDepth` (integer, required) Browser color depth in bits per pixel. This value is obtained using the `screen.colorDepth` property. Example: 24 - `riskMetadata.browserData.isJavaEnabled` (boolean, required) Specifies if Java is enabled in a browser. This value is obtained from the `navigator.javaEnabled` property. - `riskMetadata.browserData.language` (string, required) Browser language settings. This value is obtained from the `navigator.language` property. Example: en-US - `riskMetadata.browserData.screenWidth` (integer, required) Width of the browser screen. This value is obtained from the `screen.width` property. Example: 1920 - `riskMetadata.browserData.screenHeight` (integer, required) Height of the browser screen. This value is obtained from the `screen.height` property. Example: 1080 - `riskMetadata.browserData.timeZoneOffset` (integer, required) Browser time zone offset in minutes from UTC. A positive offset indicates that the local time is behind UTC. A negative offset indicates that the local time is ahead of UTC. You can find this value using the `(new Date()).getTimezoneOffset()` property. Example: 300 - `riskMetadata.browserData.isAdBlockEnabled` (boolean | null) Specifies if the usage of ad block has been detected in the browser. - `riskMetadata.extraData` (object | null) Third-party data used for risk scoring. - `riskMetadata.extraData.kountFraudSessionId` (string | null) Alpha-numeric `fraudSessionId` as provided by the Kount SDK. Example: abcdefg12345abababab123456789012 - `riskMetadata.extraData.payPalMerchantSessionId` (string | null) PayPal `MerchantSessionID` as generated by the PayPal Fraudnet SDK. Example: dd65ratxc5qv15iph3vyoq7l6davuowa - `riskMetadata.extraData.threatMetrixSessionId` (string | null) Temporary identifier that is unique to the visitor session and passed to ThreatMetrix. Example: dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa - `riskMetadata.isProxy` (boolean) Specifies if the customer's IP address is related to a proxy. - `riskMetadata.isVpn` (boolean) Specifies if the customer's IP address is related to a VPN. - `riskMetadata.isTor` (boolean) Specifies if the customer's IP address is related to TOR. - `riskMetadata.isHosting` (boolean) Specifies if the customer's IP address is related to hosting. - `riskMetadata.hostingName` (string | null) Name of the data center or hosting provider, if available. - `riskMetadata.isp` (string | null) Internet Service Provider (ISP) name, if available. - `riskMetadata.country` (string | null) Country ISO Alpha-2 code of the specified IP address. Example: US - `riskMetadata.region` (string | null) Region of the specified IP address. Example: NY - `riskMetadata.city` (string | null) City of the specified IP address. Example: New York - `riskMetadata.latitude` (number | null) Latitude of the specified IP address. - `riskMetadata.longitude` (number | null) Longitude of the specified IP address. - `riskMetadata.postalCode` (string | null) Postal code of the specified IP address. - `riskMetadata.timeZone` (string | null) Time zone of the specified IP address. Example: America/New_York - `riskMetadata.accuracyRadius` (integer | null) Accuracy radius of the specified IP address, in kilometers. - `riskMetadata.distance` (integer | null) Distance between the customer's IP address and the billing address geolocation, in kilometers. - `riskMetadata.hasMismatchedBillingAddressCountry` (boolean) Specifies if the customer's billing address country and geo-IP address are not the same. - `riskMetadata.hasMismatchedBankCountry` (boolean) Specifies if the customer's bank country and geo-IP address are not the same. - `riskMetadata.hasMismatchedTimeZone` (boolean) Specifies if the customer's browser time zone and the IP address associated time zone are not the same. - `riskMetadata.hasMismatchedHolderName` (boolean) Specifies if the customer's billing address name and primary address name are not the same. - `riskMetadata.hasFakeName` (boolean) Specifies if the holder name seems fake. - `riskMetadata.isHighRiskCountry` (boolean) Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country. - `riskMetadata.paymentInstrumentVelocity` (integer) Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours. - `riskMetadata.declinedPaymentInstrumentVelocity` (integer) Number of declined transactions for this payment instrument fingerprint in the last 24 hours. - `riskMetadata.deviceVelocity` (integer) Number of transactions for this device, based on fingerprint, in the last 24 hours. - `riskMetadata.ipVelocity` (integer) Number of transactions for this IP address in the last 24 hours. - `riskMetadata.emailVelocity` (integer) Number of transactions for this email address in the last 24 hours. - `riskMetadata.billingAddressVelocity` (integer) Number of transactions for this billing address in the last 24 hours. - `riskMetadata.paymentInstrumentApprovedTransactionCount` (integer) Number of approved transactions for this payment instrument. - `riskMetadata.score` (integer) Computed risk score based on IP risk data, such as: `isVpn`, `isTor`, and `isProxy`. - `startTime` (string | null) Date and time when the subscription starts. If this value is `null`, the current time is used. This value cannot be more than one service period in the past. Example: null - `activationTime` (string | null) Date and time when the order is activated. - `shipping` (object) Shipping settings. - `shipping.amount` (number, required) Shipping amount. - `shipping.calculator` (string, required) Shipping calculator. Enum: "manual" - `shipping.rateId` (string | null) ID of the shipping rate. If this value is not set, the cheapest applicable shipping rate is used. Example: shipping-123-456 - `shipping.amount` (number) Shipping amount which is calculated from [Shipping rates](https://www.rebilly.com/catalog/all/shipping-rates). - `autopay` (boolean) Specifies if payment attempts are made automatically. If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`, or the default payment instrument on the order. - `abandonTime` (string | null) Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, a [pending order TTL](https://www.rebilly.com/catalog/all/organizations/patchorganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value. - `abandonReminderTime` (string | null) Date and time when the abandon order reminder event triggers. - `abandonReminderNumber` (integer | null) Number of abandon order reminder events that are triggered. - `voidTime` (string | null) Date and time when the order is voided. - `churnTime` (string | null) Date and time when the order is deactivated. - `cancellationTime` (string | null) Date and time when an order is canceled. - `canceledBy` (string | null) Specifies who initiated the cancellation. Enum: "merchant", "customer", "rebilly", null - `cancelCategory` (string | null) Category of the cancellation. Enum: "billing-failure", "did-not-use", "did-not-want", "missing-features", "bugs-or-problems", "do-not-remember", "risk-warning", "contract-expired", "too-expensive", "never-started", "switched-plan", "other", null - `cancelDescription` (string | null) Description of the cancellation reason in free form. - `billingPortalToken` (string | null) Customer JWT to access a billing portal. This field is presented only if a billing portal exists. This is an experimental field and can be changed or removed in the future. - `mrr` (number) Monthly recurring revenue of the order. Example: 49.95 - `revision` (integer) Number of times the order data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. - `currentPeriodStart` (string | null) Date and time of the current service period start. - `currentPeriodEnd` (string | null) Date and time of the current service period end. If subscriptions have different recurring settings or the order is not active, providing this field causes the request to be rejected with a conflict. This field is ignored if the order is in trial. - `renewalTime` (string | null) Date and time when the next subscription in this recurring order renews. - `isNewOrder` (boolean) Specifies if the order is a new order. Example: true - `_links` (array) Related links. - `_links.href` (string) Link URL. - `_links.rel` (string) Type of link. Enum: "self" - `_embedded` (object) Embedded objects that are requested by the `expand` query parameter. - `_embedded.customer` (object) Customer information. - `_embedded.customer.id` (string) ID of the customer. Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF - `_embedded.customer.email` (string | null) Customer's email address. - `_embedded.customer.firstName` (string | null) Customer's first name. - `_embedded.customer.lastName` (string | null) Customer's last name. - `_embedded.customer.websiteId` (string) ID of the website. A website is where an organization obtains a customer. For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG - `_embedded.customer.defaultPaymentInstrument` (object | null) Default payment instrument of the customer. The default payment instrument is used to automatically pay subscription renewals, and for transaction requests where a specific payment instrument is not provided. - `_embedded.customer.defaultPaymentInstrument.method` (string, required) Payment method. Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Mollie", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MuchBetterVoucher", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PIX-Automatico", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "Quickpay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "Thunes-Checkout", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "Viva", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip" - `_embedded.customer.defaultPaymentInstrument.paymentInstrumentId` (string, required) ID of the payment instrument. Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N - `_embedded.customer.preferredPayoutInstrumentId` (string | null) ID of the customer's preferred payment instrument for payouts. Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N - `_embedded.customer.primaryAddress` (any) Customer's primary address. - `_embedded.customer.company` (object | null) Company information that is associated with the customer's primary email address domain. This is a paid feature, to enable it [contact Rebilly](https://www.rebilly.com/support/). - `_embedded.customer.company.name` (string | null) Name of the company. - `_embedded.customer.company.domain` (string) Website domain of the company. - `_embedded.customer.company.yearFounded` (number | null) Founding year of the company. - `_embedded.customer.company.industry` (string | null) Industry the company is associated with. - `_embedded.customer.company.employeesCount` (number | null) Number of employees in the company. - `_embedded.customer.company.country` (string | null) Country where the company is based. - `_embedded.customer.company.locality` (string | null) Locality or region where the company is based. - `_embedded.customer.company._links` (array) - `_embedded.customer.company._links.href` (string) Link URL. - `_embedded.customer.company._links.rel` (string) Type of link. Enum: "linkedin" - `_embedded.customer.averageValue` (object) Average customer value. - `_embedded.customer.averageValue.amount` (number) Average amount of approved payments in the merchant's reporting currency. - `_embedded.customer.averageValue.amountUsd` (number) Average approved payment amount in USD. - `_embedded.customer.paymentCount` (integer) Total number of approved payments made by the customer. Payments are the result of `sale` or `capture` transactions. - `_embedded.customer.lastPaymentTime` (string | null) Date and time when the customer made their last approved payment. Payments are the result of `sale` or `capture` transactions. - `_embedded.customer.lifetimeRevenue` (object) Customer's lifetime revenue. - `_embedded.customer.lifetimeRevenue.amount` (number) Revenue amount in the merchant's reporting currency. - `_embedded.customer.lifetimeRevenue.amountUsd` (number) Revenue amount in USD. - `_embedded.customer.invoiceCount` (integer) Total number of invoices issued to the customer. This value is auto-incrementing. If this value is `0`, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to `1` the record relates to a customer. - `_embedded.customer.tags` (array) List of customer tags. - `_embedded.customer.tags.name` (string, required) Unique name for the tag. Tag names are not case-sensitive. Example: New - `_embedded.customer.tags.type` (string, required) Type of tag. Tags of a specific type can only be assigned to corresponding entity types. For example, you can only use customer tags on customers. Enum: "customer", "kyc-document", "aml-check" - `_embedded.customer.revision` (integer) Number of times the customer's data has been modified. Use this value when analyzing webhook data to determine if a change must take precedence over the current representation. - `_embedded.customer.hasFulfilledKyc` (boolean) Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document. - `_embedded.customer.organizationId` (string) Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: org_0YVDM8RC7GDADADSBSMW124JA8 - `_embedded.customer.locale` (string | null) Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format. Example: fr-FR - `_embedded.customer.taxNumbers` (array | null) Tax numbers of the customer. - `_embedded.customer.taxNumbers.type` (string, required) Type of the tax number. Enum: "eu-vat", "other" - `_embedded.customer.taxNumbers.value` (string, required) Value of the tax number. Example: GB980780684 - `_embedded.customer.taxNumbers.isDefault` (boolean) Determines if the tax number is selected as default to display on invoices. Example: true - `_embedded.customer.taxNumbers.isValid` (boolean | null) Determines if the tax number passed the EU official [VIES validation](https://ec.europa.eu/taxation_customs/vies/#/vat-validation). Example: true - `_embedded.customer.leadSource` (object) Lead source information. - `_embedded.customer.leadSource.medium` (string | null) Category of the lead source traffic. For example, the medium could be organic search, Google ads, Display ads, and so on. - `_embedded.customer.leadSource.source` (string | null) Domain, platform, or channel from which the lead source originates. - `_embedded.customer.leadSource.campaign` (string | null) Campaign name of the lead source. - `_embedded.customer.leadSource.term` (string | null) Term associated with a lead source. - `_embedded.customer.leadSource.content` (string | null) Content contained in the lead source content. For example, content could be graphics, video, and so on. - `_embedded.customer.leadSource.affiliate` (string | null) Individual or entity that is affiliated with the lead source. - `_embedded.customer.leadSource.subAffiliate` (string | null) Individual or entity that is associated with a lead source affiliate. In other products, this field may also be referred to as sub ID or click ID in some. - `_embedded.customer.leadSource.salesAgent` (string | null) Name of the sales agent associated with the lead source. - `_embedded.customer.leadSource.clickId` (string | null) ID of the lead source click. This value is passed in the ad click URL for tracking and campaign attribution. - `_embedded.customer.leadSource.path` (string | null) URL from which the lead source originates. - `_embedded.customer.leadSource.referrer` (string | null) Lead source [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer). Example: https://www.rebilly.com - `_embedded.customer.leadSource._links` (array) Related links. - `_embedded.customer.leadSource._links.href` (string) Link URL. - `_embedded.customer.leadSource._links.rel` (string) Type of link. Enum: "self", "customer" - `_embedded.customer.personId` (string | null) ID of the associated person. Example: prs_0YV7DDSDD1C8DA64KHH2W33CPF - `_embedded.customer.notificationEmails` (array) Email addresses for notification delivery in event-based email notifications. When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify. For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails). - `_embedded.customer._links` (array) Related links. - `_embedded.customer._links.href` (string) Link URL. - `_embedded.customer._links.rel` (string) Type of link. Enum: "self", "attachments", "defaultPaymentInstrument", "leadSource", "website" - `_embedded.customer._embedded` (object) Embedded objects that are requested using the `expand` query string parameter. - `_embedded.customer._embedded.defaultPaymentInstrument` (object) - `_embedded.customer._embedded.website` (object) - `_embedded.customer._embedded.leadSource` (object) - `_embedded.activationInvoice` (object) - `_embedded.activationInvoice.id` (string) ID of the invoice. Example: in_0YVF9605RKC62BP14NE2R7V2XT - `_embedded.activationInvoice.invoiceNumber` (integer) Auto-incrementing number based on the sequence of invoices for any particular customer. - `_embedded.activationInvoice.orderId` (string | null) ID of the order (experimental). Example: ord_01HVKA5975PJBSQ1SX72G3MSZC - `_embedded.activationInvoice.subscriptionId` (string) ID of the related subscription order, if available. This field is `null` if there are no related subscription orders. Example: sub_01HRF27SATGE4Z6PBJE6PD8328 - `_embedded.activationInvoice.quoteId` (string | null) ID of the related quote, if available. This field is `null` if there are no related quotes. Example: qt_01HXBZMEGPETPHJZH6V4RHBMA8 - `_embedded.activationInvoice.amount` (number) Amount of the invoice. - `_embedded.activationInvoice.amountDue` (number) Amount that is due on the invoice. - `_embedded.activationInvoice.subtotalAmount` (number) Subtotal amount of the invoice. - `_embedded.activationInvoice.discountAmount` (number) Discount amount that is applied to the invoice. - `_embedded.activationInvoice.tax` (object) Taxes. - `_embedded.activationInvoice.tax.calculator` (string, required) Type of tax calculator. Enum: "manual" - `_embedded.activationInvoice.tax.amount` (number) Total amount of taxes. - `_embedded.activationInvoice.tax.items` (array, required) Taxes applied. - `_embedded.activationInvoice.tax.items.amount` (number, required) Amount of the tax. - `_embedded.activationInvoice.tax.items.description` (string, required) Description of the tax. - `_embedded.activationInvoice.tax.items.rate` (number | null) Overall sales tax rate which includes state, county, city and district tax. - `_embedded.activationInvoice.tax.items.stateAmount` (number | null) Amount of sales tax to collect for the state. Example: 0.94 - `_embedded.activationInvoice.tax.items.countyAmount` (number | null) Amount of sales tax to collect for the county. Example: 0.04 - `_embedded.activationInvoice.tax.items.cityAmount` (number | null) Amount of sales tax to collect for the city. Example: 0 - `_embedded.activationInvoice.tax.items.specialDistrictAmount` (number | null) Amount of sales tax to collect for the special district. Example: 0.38 - `_embedded.activationInvoice.tax.items.stateRate` (number | null) State sales tax rate for given location. - `_embedded.activationInvoice.tax.items.countyRate` (number | null) County sales tax rate for given location. - `_embedded.activationInvoice.tax.items.cityRate` (number | null) City sales tax rate for given location. - `_embedded.activationInvoice.tax.items.specialDistrictRate` (number | null) Special district sales tax rate for given location. - `_embedded.activationInvoice.tax.items.jurisdictions` (object | null) Jurisdiction names for the invoice. - `_embedded.activationInvoice.tax.items.jurisdictions.country` (string | null) Two-letter ISO country code for the provided location. Example: US - `_embedded.activationInvoice.tax.items.jurisdictions.state` (string | null) Postal abbreviated state name for the provided location. Example: CA - `_embedded.activationInvoice.tax.items.jurisdictions.county` (string | null) County name for the provided location. Example: LOS ANGELES - `_embedded.activationInvoice.tax.items.jurisdictions.city` (string | null) City name for the provided location. Example: LOS ANGELES - `_embedded.activationInvoice.tax.items` (array) Taxes applied and calculated based on the `taxCategoryId` of the related product. - `_embedded.activationInvoice.organizationTaxIdNumber` (object | null) Organization tax ID number that is displayed on the invoice. - `_embedded.activationInvoice.organizationTaxIdNumber.type` (string, required) Type of the tax ID number. Enum: "eu-vat", "other" - `_embedded.activationInvoice.organizationTaxIdNumber.value` (string, required) Value of the tax ID number. Example: GB980780684 - `_embedded.activationInvoice.customerTaxIdNumber` (object | null) Customer tax ID number that is displayed on the invoice. - `_embedded.activationInvoice.customerTaxIdNumber.type` (string, required) Type of the tax ID number. Enum: "eu-vat", "other" - `_embedded.activationInvoice.customerTaxIdNumber.value` (string, required) Value of the tax ID number. Example: GB980780684 - `_embedded.activationInvoice.poNumber` (string | null) Purchase order number that is displayed on the invoice. Example: PO123456 - `_embedded.activationInvoice.notes` (string) Notes for the customer that are displayed on the invoice. - `_embedded.activationInvoice.items` (array) Invoice items array. - `_embedded.activationInvoice.items.id` (string) ID of the invoice item. Example: ii_0YVFDEQS2KCFTBN9HXWJFY55GV - `_embedded.activationInvoice.items.type` (string, required) Type of invoice item. Enum: "debit", "credit" - `_embedded.activationInvoice.items.description` (string) Description of the invoice item. - `_embedded.activationInvoice.items.unitPrice` (number, required) Unit price of the invoice item. - `_embedded.activationInvoice.items.quantity` (integer) Quantity of the invoice item. - `_embedded.activationInvoice.items.price` (number) Total price of the invoice item. - `_embedded.activationInvoice.items.productId` (string | null) ID of the product. Example: prod_0YV7DES3WPC5J8JD8QTVNZBZNZ - `_embedded.activationInvoice.items.planId` (string | null) ID of the plan. Example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X - `_embedded.activationInvoice.items.subscriptionId` (string | null) ID of the order. Example: sub_01HRF27SATGE4Z6PBJE6PD8328 - `_embedded.activationInvoice.items.periodStartTime` (string | null) Date and time when the billing period starts. - `_embedded.activationInvoice.items.periodEndTime` (string | null) Date and time when the billing period ends. - `_embedded.activationInvoice.items.periodNumber` (integer | null) Billing period number that is associated with the invoice item. For example, an invoice item for a service is included in billing period number 3. The invoice item is only applied to billing period number 3. - `_embedded.activationInvoice.items.tax` (any) Invoice item tax. - `_embedded.activationInvoice.items._links` (array) Related links. - `_embedded.activationInvoice.items._links.href` (string) Link URL. - `_embedded.activationInvoice.items._links.rel` (string) Type of link. Enum: "self", "product", "subscription", "plan" - `_embedded.activationInvoice.items._embedded` (object) Embedded objects that are requested by the `expand` query parameter. - `_embedded.activationInvoice.items._embedded.product` (object) - `_embedded.activationInvoice.items._embedded.plan` (object) - `_embedded.activationInvoice.discounts` (array) Discounts applied. - `_embedded.activationInvoice.discounts.couponId` (string) ID of the coupon. Example: cpn_0YVCNKF81GD778N4YNVGDJK558 - `_embedded.activationInvoice.discounts.amount` (number) Total amount discounted by this coupon. - `_embedded.activationInvoice.discounts.description` (string) Description of the discount. - `_embedded.activationInvoice.discounts.context` (string) Context in which the discount applies. Enum: "items", "shipping", "items-and-shipping" - `_embedded.activationInvoice.autopayScheduledTime` (string | null) Date and time when an automatic payment (autopay) is scheduled. - `_embedded.activationInvoice.autopayRetryNumber` (integer) Number of times that an automatic payment (autopay) has been attempted on an invoice. - `_embedded.activationInvoice.status` (string) Status of the invoice. Enum: "draft", "quotation", "unpaid", "paid", "partially-paid", "past-due", "abandoned", "voided", "partially-refunded", "refunded", "disputed" - `_embedded.activationInvoice.delinquentCollectionPeriod` (integer) Length of time, in days, between when the invoice is due and when the invoice is paid. - `_embedded.activationInvoice.collectionPeriod` (integer) Length of time, in days, between when the invoice is issued and when the invoice is paid. - `_embedded.activationInvoice.abandonedTime` (string | null) Date and time when the invoice is abandoned. - `_embedded.activationInvoice.voidedTime` (string | null) Date and time when the invoice is voided. - `_embedded.activationInvoice.paidTime` (string | null) Date and time when the invoice is paid. - `_embedded.activationInvoice.dueTime` (string) Date and time when the invoice is due for payment. - `_embedded.activationInvoice.issuedTime` (string) Read-only timestamp in ISO 8601 date-time format. - `_embedded.activationInvoice.paymentFormUrl` (string | null) URL where the customer is redirected to pay the invoice using one of the methods which are available to the customer. This is an alternative to creating a new transaction with empty `methods`. - `_embedded.activationInvoice.creditMemoAllocations` (array) Credit memo allocations to an invoice. - `_embedded.activationInvoice.creditMemoAllocations.invoiceId` (string) ID of invoice to which the credit memo is allocated. Example: in_0YVF9605RKC62BP14NE2R7V2XT - `_embedded.activationInvoice.creditMemoAllocations.amount` (number) Amount of credit that is allocated from the credit memo to the invoice. If the `amount` value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used: - The unused amount of the credit memo. - The invoice due amount. - `_embedded.activationInvoice.isNewOrder` (boolean) Specifies if the order is a new order. Example: true - `_embedded.activationInvoice.customerId` (string, required) ID of the customer resource. Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF - `_embedded.activationInvoice.transactions` (array) Up to 10 of the most recent transactions for the invoice. To retrieve transactions for an invoice, use [Retrieve transactions](https://www.rebilly.com/catalog/all/transactions/gettransactioncollection) with the `invoiceIds` filter. Search results can lag briefly behind a write. - `_embedded.activationInvoice.transactions.id` (string) ID of the transaction. Example: txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0 - `_embedded.activationInvoice.transactions.websiteId` (string) ID of the website. A website is where an organization obtains a customer. For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG - `_embedded.activationInvoice.transactions.customerId` (string) ID of the customer resource. Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF - `_embedded.activationInvoice.transactions.type` (string) Type of transaction. Enum: "3ds-authentication", "authorize", "capture", "credit", "refund", "sale", "setup", "void" - `_embedded.activationInvoice.transactions.status` (string) Status of the transaction. Enum: "completed", "conn-error", "disputed", "never-sent", "offsite", "partially-refunded", "pending", "refunded", "sending", "timeout", "voided", "waiting-approval", "waiting-capture", "waiting-gateway", "waiting-refund" - `_embedded.activationInvoice.transactions.result` (string) Result of the transaction. Enum: "abandoned", "approved", "canceled", "declined", "unknown" - `_embedded.activationInvoice.transactions.amount` (number) Total amount of the transaction. - `_embedded.activationInvoice.transactions.purchaseAmount` (number) Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount. - `_embedded.activationInvoice.transactions.requestAmount` (number) Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount. - `_embedded.activationInvoice.transactions.childTransactions` (array) IDs of child transactions. - `_embedded.activationInvoice.transactions.invoiceIds` (array) Related invoice IDs. - `_embedded.activationInvoice.transactions.subscriptionIds` (array) Subscription IDs of invoices that are related to the transaction. - `_embedded.activationInvoice.transactions.planIds` (array) Plan IDs of orders that are related to the transaction. - `_embedded.activationInvoice.transactions.isRebill` (boolean) Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees. - `_embedded.activationInvoice.transactions.rebillNumber` (integer) Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees. - `_embedded.activationInvoice.transactions.has3ds` (boolean) Specifies if the transaction uses 3D Secure. - `_embedded.activationInvoice.transactions.3ds` (object) Authentication object. For more information, see [3D Secure (3DS)](https://www.rebilly.com/docs/settings/3ds/). - `_embedded.activationInvoice.transactions.3ds.server` (string) Name of the 3D Secure server. - `_embedded.activationInvoice.transactions.3ds.version` (string) Version of 3D Secure. Enum: "1.0.2", "2.1.0", "2.2.0" - `_embedded.activationInvoice.transactions.3ds.enrolled` (string) Specifies if the cardholder is enrolled in 3D Secure. Enum: "yes", "no", "invalid card/timeout", "unavailable" - `_embedded.activationInvoice.transactions.3ds.authenticated` (string) Authentication response status for 3D Secure. Enum: "yes", "no", "not applicable", "attempted" - `_embedded.activationInvoice.transactions.3ds.liability` (string) Enum: "protected", "not protected", "protected (attempt)" - `_embedded.activationInvoice.transactions.3ds.flow` (string) Authentication flow for 3D Secure 2. Enum: "frictionless", "challenge" - `_embedded.activationInvoice.transactions.3ds.isDowngraded` (boolean) Specifies if 3D Secure 2 is attempted and downgraded to 3D Secure 1. - `_embedded.activationInvoice.transactions.redirectUrl` (string | null) URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL. - `_embedded.activationInvoice.transactions.retryNumber` (integer) Position of the transaction in the sequence of retries. - `_embedded.activationInvoice.transactions.isRetry` (boolean) Specifies if a transaction is a retry. - `_embedded.activationInvoice.transactions.billingDescriptor` (string | null) Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters. - `_embedded.activationInvoice.transactions.description` (string) Description of the payment. - `_embedded.activationInvoice.transactions.requestId` (string) Request ID of the transaction. This ID must be unique within a 24-hour period. Use this field to prevent duplicate transactions. - `_embedded.activationInvoice.transactions.hasAmountAdjustment` (boolean) Specifies if the transaction has amount adjustment. - `_embedded.activationInvoice.transactions.gatewayName` (string | null) Name of the payment gateway that processed, or is selected to process, the transaction. This value is only available after a gateway is selected for the transaction. Enum: "A1Gateway", "ACI", "Adyen", "Aera", "Aircash", "Airpay", "Airwallex", "AsiaPay", "AmazonPay", "AmexVPC", "Antom", "ApcoPay", "AsiaPaymentGateway", "AstroPayCard", "AuthorizeNet", "Awepay", "Bambora", "BankSEND", "BitPay", "BlueSnap", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "Cashflows", "CASHlib", "Cashterminal", "CashToCode", "CauriPayment", "Cayan", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Cps", "Credorax", "Cryptomus", "Cryptonator", "CyberSource", "DataCash", "Dengi", "Dimoco", "Directa24", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "ecoPayzTurkey", "EcorePay", "Elavon", "Euteller", "eMerchantPay", "EMS", "ePay", "EPG", "EPro", "Ezeebill", "eZeeWallet", "ezyEFT", "FasterPay", "Finrax", "Flexepin", "FinTecSystems", "FundSend", "Forte", "gate2way", "GET", "Gigadat", "GlobalOnePay", "GoCardless", "Gooney", "Gpaysafe", "Greenbox", "HiPay", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "iDebit", "Ilixium", "IMerchant", "Ingenico", "INOVAPAY", "Inovio", "Intuit", "InstaDebit", "IpayOptions", "Isx", "JetPay", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "LaCore", "Limepay", "Loonio", "loonie", "LPG", "MaxiCash", "MercadoPago", "MiFinity", "Mollie", "MobilePay", "Moneris", "Monolo", "MonRem", "MtaPay", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "Naewe", "Neosurf", "Netbanking", "Neteller", "NGenius", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Pagadito", "Pagsmile", "Panamerican", "ParamountCommerce", "ParamountEft", "ParamountInterac", "PandaGateway", "Pay4Fun", "Paybilt", "PayCash", "Paycly", "PayClub", "PayCom", "PayEcards", "Payeezy", "Payflow", "PayGlocal", "Paynote", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "Paysafe", "Paysafecard", "Paysafecash", "PayTabs", "PayU", "PayULatam", "Payvision", "PayXpert", "PharosPayments", "Piastrix", "Pin4Pay", "Plugnpay", "PostFinance", "Powertranz", "PPRO", "Prosa", "PSiGate", "Quickpay", "Rapyd", "Realex", "Realtime", "Redsys", "Rotessa", "RPN", "Safecharge", "SaltarPay", "Sagepay", "SeamlessChex", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "Splitit", "StaticGateway", "STPMexico", "Stripe", "Tabby", "Telr", "TestProcessor", "Thunes", "ToditoCash", "Triple000", "Truevo", "TrustsPay", "Trustly", "TWINT", "Txn", "Unlimit", "UPayCard", "USAePay", "VantivLitle", "vegaaH", "VCreditos", "VegaWallet", "Viva", "Wallet88", "Walpay", "WesternUnion", "Wirecard", "WorldlineAtosFrankfurt", "Worldpay", "XPay", "Zimpler", "Zotapay" - `_embedded.activationInvoice.transactions.gatewayAccountId` (string | null) ID of the gateway account that processed the transaction. Example: gw_acc_0YVCXMF26DDNKAERE5NW727S34 - `_embedded.activationInvoice.transactions.gatewayTransactionId` (string | null) ID of the gateway transaction. Example: txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0 - `_embedded.activationInvoice.transactions.gateway` (object) Related gateway information. - `_embedded.activationInvoice.transactions.gateway.response` (object) Gateway response. - `_embedded.activationInvoice.transactions.gateway.response.code` (string | null) Gateway response code. - `_embedded.activationInvoice.transactions.gateway.response.message` (string | null) Gateway response message. - `_embedded.activationInvoice.transactions.gateway.response.type` (string | null) Gateway response type. - `_embedded.activationInvoice.transactions.gateway.response.originalCode` (string | null) Raw, unmapped gateway response code. - `_embedded.activationInvoice.transactions.gateway.response.originalMessage` (string | null) Raw, unmapped gateway response message. - `_embedded.activationInvoice.transactions.gateway.avsResponse` (object) Gateway Address Verification System (AVS) response. - `_embedded.activationInvoice.transactions.gateway.avsResponse.code` (string | null) Response code. - `_embedded.activationInvoice.transactions.gateway.avsResponse.message` (string | null) Response message. - `_embedded.activationInvoice.transactions.gateway.avsResponse.originalCode` (string | null) Raw response code. - `_embedded.activationInvoice.transactions.gateway.avsResponse.originalMessage` (string | null) Raw response message. - `_embedded.activationInvoice.transactions.gateway.cvvResponse` (object) Gateway Card Verification Value (CVV) response. - `_embedded.activationInvoice.transactions.gateway.cvvResponse.code` (string | null) Response code. - `_embedded.activationInvoice.transactions.gateway.cvvResponse.message` (string | null) Response message. - `_embedded.activationInvoice.transactions.gateway.cvvResponse.originalCode` (string | null) Raw response code. - `_embedded.activationInvoice.transactions.gateway.cvvResponse.originalMessage` (string | null) Raw response message. - `_embedded.activationInvoice.transactions.acquirerName` (string | null) Acquirer name. This value is only available when a transaction uses a payment gateway. If a transaction does not use a payment gateway, this value is `null`. Enum: "Adyen", "ACI", "Aera", "Alipay", "AIB", "Aircash", "Airpay", "AmazonPay", "ApcoPay", "AsiaPaymentGateway", "AstroPay Card", "Awepay", "Ipay Options", "B+S", "Bambora", "BitPay", "Bank of America", "Bank of Moscow", "Bank of Rebilly", "Bank One", "BankSEND", "BMO Harris Bank", "Borgun", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "CASHlib", "Cashterminal", "CashToCode", "Catalunya Caixa", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "ChinaUnionPay", "CIM", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Cps", "Credorax", "Cryptonator", "CyberSource", "Dimoco", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "EcorePay", "Elavon", "EMS", "ePay", "EPG", "Euteller", "Ezeebill", "eZeeWallet", "ezyEFT", "Fifth Third Bank", "Finrax", "First Data Buypass", "First Data Nashville", "First Data North", "First Data Omaha", "FinTecSystems", "Flexepin", "Forte", "FundSend", "gate2way", "Gigadat", "Global East", "Gooney", "Gpaysafe", "Heartland", "HiPay", "HSBC", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "Ilixium", "Ingenico", "INOVAPAY", "Intuit", "Isx", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "Limepay", "Loonio", "loonie", "LPG", "Masapay", "MaxiCash", "MercadoPago", "Merrick", "Mission Valley Bank", "MiFinity", "MobilePay", "Moneris", "Monolo", "MonRem", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "NATWEST", "Neosurf", "Netbanking", "Neteller", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "Nuvei", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Other", "Panamerican", "Panda Bank", "Paramount", "ParamountCommerce", "ParamountEft", "ParamountInterac", "Pay4fun", "Paybilt", "PayCash", "PayClub", "PayEcards", "PayGlocal", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "Paynetics", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "PayTabs", "PayU", "PayULatam", "Payvision", "PharosPayments", "Piastrix", "Pin4Pay", "Peoples Trust Company", "PostFinance", "PPRO", "Privatbank", "Prosa", "PSiGate", "QQPay", "Rapyd", "RBC", "RBS WorldPay", "RealTime", "Rotessa", "Safecharge", "SaltarPay", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "State Bank of Mauritius", "STPMexico", "Stripe", "Tabby", "TBI", "Telr", "TestProcessor", "Thunes", "ToditoCash", "Triple000", "Truevo", "Trustly", "TrustPay", "TrustsPay", "TSYS", "TWINT", "Txn", "UPayCard", "Vantiv", "VCreditos", "VegaWallet", "VoicePay", "Wallet88", "WeChat Pay", "Wells Fargo", "Wing Hang Bank", "Wirecard", "WorldPay", "XPay", "Zimpler", "Zotapay" - `_embedded.activationInvoice.transactions.method` (string) Payment method. > **Note:** Use `paymentInstrument.method` instead. Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Mollie", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MuchBetterVoucher", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PIX-Automatico", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "Quickpay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "Thunes-Checkout", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "Viva", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip" - `_embedded.activationInvoice.transactions.velocity` (integer) Number of transactions by the same customer in the past 24 hours. - `_embedded.activationInvoice.transactions.revision` (integer) Number of times the transaction data has been modified. This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation. - `_embedded.activationInvoice.transactions.referenceData` (object | null) Transaction reference data. Example: {"gatewayTransactionId":"GAT123"} - `_embedded.activationInvoice.transactions.bin` (string | null) Payment card Bank Identification Number (BIN). - `_embedded.activationInvoice.transactions.paymentInstrumentFingerprint` (string | null) Unique value that is used to identify the payment instrument of the transaction. This value is `null` if the transaction has no payment instrument, or the payment instrument has no fingerprint. - `_embedded.activationInvoice.transactions.paymentInstrument` (object) - `_embedded.activationInvoice.transactions.paymentInstrument.method` (string, required) Payment method supported vault. For more information, see [Payment instrument](https://www.rebilly.com/catalog/all/payment-instruments). Enum: "payment-card", "ach", "paypal" - `_embedded.activationInvoice.transactions.paymentInstrument.paymentInstrumentId` (string, required) ID of the payment instrument. Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N - `_embedded.activationInvoice.transactions.paymentInstrument.method` (string, required) Payment method. Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Mollie", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MuchBetterVoucher", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PIX-Automatico", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "Quickpay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "Thunes-Checkout", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "Viva", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip" - `_embedded.activationInvoice.transactions.paymentInstrument.reference` (string | null) Reference data. This field is available only for the `bank-transfer` payment method. - `_embedded.activationInvoice.transactions.paymentInstrument.method` (string, required) Enum: "cash" - `_embedded.activationInvoice.transactions.paymentInstrument.receivedBy` (string) Individual or entity that received the payment. - `_embedded.activationInvoice.transactions.paymentInstrument.reference` (string) Reference data. - `_embedded.activationInvoice.transactions.hasDcc` (boolean) Specifies if Dynamic Currency Conversion (DCC) applies to the transaction. - `_embedded.activationInvoice.transactions.dcc` (object | null) Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is `null`. - `_embedded.activationInvoice.transactions.dcc.base` (object) - `_embedded.activationInvoice.transactions.dcc.base.amount` (number, required) Example: 10 - `_embedded.activationInvoice.transactions.dcc.outcome` (string) Dynamic currency conversion outcome. Enum: "unprocessed", "rejected", "selected" - `_embedded.activationInvoice.transactions.dcc.isForceDcc` (boolean) Specifies if Dynamic Currency Conversion (DCC) is forced for the transaction. - `_embedded.activationInvoice.transactions.riskScore` (integer) Risk score for the transaction. - `_embedded.activationInvoice.transactions.riskMetadata` (any) - `_embedded.activationInvoice.transactions.notificationUrl` (string | null) URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction. Do not interpret this notification as a confirmation, complete a `GET` request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a `2xx` HTTP status code. The following placeholders are available to use in this URI: `{id}` and `{result}`. These placeholders are replaced the with the transaction ID and result accordingly. - `_embedded.activationInvoice.transactions.isDisputed` (boolean) Specifies if a transaction is disputed. - `_embedded.activationInvoice.transactions.disputeTime` (string | null) Date and time when the dispute is created. If the transaction is not disputed, this value is `null`. - `_embedded.activationInvoice.transactions.disputeStatus` (string | null) Status of the dispute. Enum: null, "response-needed", "under-review", "forfeited", "won", "lost", "unknown" - `_embedded.activationInvoice.transactions.isReconciled` (boolean) Specifies if the transaction is verified with gateway batch data. - `_embedded.activationInvoice.transactions.isProcessedOutside` (boolean) Specifies if the transaction is processed outside of Rebilly. - `_embedded.activationInvoice.transactions.isMerchantInitiated` (boolean) Specifies if the transaction is initiated by the merchant. - `_embedded.activationInvoice.transactions.hadDiscrepancy` (boolean) Specifies if the transaction is updated due to a discrepancy with its source of truth. - `_embedded.activationInvoice.transactions.orderId` (string) Order ID of the transaction. This ID must be unique within a 24 hour period. > **Note:** Use the `requestId` field instead. - `_embedded.activationInvoice.transactions.arn` (string | null) Acquirer reference number. Example: 74836950144358910018150 - `_embedded.activationInvoice.transactions.reportAmount` (number) Transaction amount converted to the report currency of the organization. - `_embedded.activationInvoice.transactions.settlementTime` (string | null) Date and time when the transaction is settled by the banking institution. - `_embedded.activationInvoice.transactions.discrepancyTime` (string | null) Date and time of the most recent discrepancy on the transaction. - `_embedded.activationInvoice.transactions.limits` (object | null) Transaction amount limit information. - `_embedded.activationInvoice.transactions.limits.amount` (number) Limit amount. Example: 275.35 - `_embedded.activationInvoice.transactions.limits.resetTime` (string | null) Date and time in which the limit amount resets. This value may be used for user interfaces. - `_embedded.activationInvoice.transactions.organizationId` (string) Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: org_0YVDM8RC7GDADADSBSMW124JA8 - `_embedded.activationInvoice.transactions.depositRequestId` (string | null) ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request. Example: dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7 - `_embedded.activationInvoice.transactions.transferId` (string | null) ID of the ledger transfer if applicable. The transaction is linked to this transfer when processed in the wallet ledger. Example: tb_0YVDTQJ8YWDGQACV2N2N5SPWQ0 - `_embedded.activationInvoice.transactions.payoutRequestId` (string | null) ID of the payout request if applicable. The created transaction is based on the properties of this payout request. Example: pout_req_0YVDMDE2BMC6KBB5MX76RF6T80 - `_embedded.activationInvoice.transactions._links` (array) Related links. - `_embedded.activationInvoice.transactions._links.href` (string) Link URL. - `_embedded.activationInvoice.transactions._links.rel` (string) Type of link. Enum: "self", "attachments", "website", "customer", "gatewayAccount", "paymentCard", "parentTransaction", "leadSource", "approvalUrl", "refundUrl", "updateUrl", "disputes", "invoices", "queryUrl", "redirectUrl" - `_embedded.activationInvoice.transactions._embedded` (object) Embedded objects that are requested by the `expand` query parameter. - `_embedded.activationInvoice.transactions._embedded.parentTransaction` (object) - `_embedded.activationInvoice.transactions._embedded.childTransactions` (array) Most recent child transactions. - `_embedded.activationInvoice.transactions._embedded.gatewayAccount` (object) - `_embedded.activationInvoice.transactions._embedded.customer` (object) - `_embedded.activationInvoice.transactions._embedded.leadSource` (object) - `_embedded.activationInvoice.transactions._embedded.website` (object) - `_embedded.activationInvoice.transactions._embedded.invoices` (array) Most recent related invoices. - `_embedded.activationInvoice.transactions._embedded.organization` (object) - `_embedded.activationInvoice.transactions._embedded.dispute` (object) - `_embedded.activationInvoice.transactions._embedded.paymentCard` (object) - `_embedded.activationInvoice.transactions._embedded.bankAccount` (object) - `_embedded.activationInvoice.retryInstruction` (object | null) Invoice payment retry instruction. This object specifies how to proceed if a payment related to the invoice fails. - `_embedded.activationInvoice.retryInstruction.attempts` (array, required) Describes the retry instruction. - `_embedded.activationInvoice.retryInstruction.attempts.scheduleInstruction` (object, required) Specifies when the payment retry instruction is performed. - `_embedded.activationInvoice.retryInstruction.attempts.scheduleInstruction.method` (string, required) Enum: "date-interval" - `_embedded.activationInvoice.retryInstruction.attempts.scheduleInstruction.duration` (integer, required) Number of time units. - `_embedded.activationInvoice.retryInstruction.attempts.scheduleInstruction.unit` (any, required) Unit of time. - `_embedded.activationInvoice.retryInstruction.attempts.scheduleInstruction.anchor` (object) Instruction for calculating the period anchor. - `_embedded.activationInvoice.retryInstruction.attempts.scheduleInstruction.duration` (integer, required) Latest point in time at which the event should occur. The event occurs at a random time between the initial time and duration time. - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction` (object) Specifies if the payment amount must be adjusted for the retry. - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction.method` (string, required) Enum: "partial" - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction.value` (number, required) Amount of the payment. - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction.type` (string, required) Payment amount type. Enum: "percent", "fixed" - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction.afterApprovalPolicy` (any) After an approved payment retry for an adjusted amount, this field specifies whether to discount the remaining invoice amount. - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction.afterApprovalPolicy.method` (string, required) No payment amount adjustment. Enum: "none" - `_embedded.activationInvoice.retryInstruction.attempts.amountAdjustmentInstruction.afterApprovalPolicy.method` (string, required) Discount the remaining amount on the invoice. Enum: "discount-amount-remaining" - `_embedded.activationInvoice.retryInstruction.attempts.tryBackupInstruments` (boolean) Specifies whether to use backup payment instruments on an invoice payment retry. - `_embedded.activationInvoice.retryInstruction.afterAttemptPolicies` (array, required) Describes the action to take when a payment attempt concludes, and payment is not collected. - `_embedded.activationInvoice.retryInstruction.afterRetryEndPolicies` (array, required) Describes the action to take when all scheduled payment retries, in a retry instruction, have concluded and payment is not collected. - `_embedded.activationInvoice.revision` (integer) Number of times the invoice data has been modified. Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation. - `_embedded.activationInvoice.type` (string) Type of invoice. Enum: "initial", "renewal", "interim", "cancellation", "one-time", "refund", "charge", "one-time-sale" - `_embedded.activationInvoice.dueReminderTime` (string | null) Date and time when a past due reminder event is triggered. - `_embedded.activationInvoice.dueReminderNumber` (integer | null) Number of past due reminder events that have been triggered. - `_embedded.activationInvoice.organizationId` (string) Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: org_0YVDM8RC7GDADADSBSMW124JA8 - `_embedded.activationInvoice.delinquencyTime` (string | null) Date and time when the related order is considered delinquent, and is canceled. If this value is `null`, no delinquency time is configured. If the `dueTime` of the order becomes greater than the `delinquencyTime` value, the `delinquencyTime` value becomes equal to `dueTime`. If an invoice is not related to an order, this field can only be `null`. - `_embedded.activationInvoice._links` (array) Related links. - `_embedded.activationInvoice._links.href` (string) Link URL. - `_embedded.activationInvoice._links.rel` (string) Type of link. Enum: "self", "website", "customer", "organization", "attachments", "leadSource", "transactionAllocations", "recalculateInvoice", "subscription" - `_embedded.activationInvoice._embedded` (object) Embedded objects that are requested by the `expand` query parameter. - `_embedded.activationInvoice._embedded.customer` (object) - `_embedded.activationInvoice._embedded.website` (object) - `_embedded.activationInvoice._embedded.organization` (object) - `_embedded.activationInvoice._embedded.leadSource` (object) - `_embedded.activationInvoice._embedded.shippingRate` (object) - `_embedded.upcomingInvoice` (object) - `_embedded.upcomingInvoice.id` (string) ID of the upcoming invoice. This value is persisted in the future renewal invoice. Example: in_0YVF9605RKC62BP14NE2R7V2XT - `_embedded.upcomingInvoice.revision` (integer) Number of times the upcoming invoice data has changed. Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation. - `_embedded.upcomingInvoice.items` (array) Upcoming invoice items array. - `_embedded.upcomingInvoice.items.id` (string) ID of the upcoming invoice item. Example: ii_0YVFDEQS2KCFTBN9HXWJFY55GV - `_embedded.upcomingInvoice.items.isInterim` (boolean) Specifies if the line item is added to an interim invoice. - `_embedded.upcomingInvoice.items.description` (string) Description of the upcoming invoice item. - `_embedded.upcomingInvoice.items.unitPrice` (number) Unit price of the upcoming invoice item. - `_embedded.upcomingInvoice.items.quantity` (integer) Quantity of the upcoming invoice item. - `_embedded.upcomingInvoice.items.price` (number) Total price of the upcoming invoice item. - `_embedded.upcomingInvoice.items.productId` (string | null) ID of the product. Example: prod_0YV7DES3WPC5J8JD8QTVNZBZNZ - `_embedded.upcomingInvoice.items.planId` (string | null) ID of the plan. Example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X - `_embedded.upcomingInvoice.items.orderId` (string) ID of the order. Example: ord_01HVKA5975PJBSQ1SX72G3MSZC - `_embedded.upcomingInvoice.items.periodStartTime` (string) Date and time when the billing period starts. - `_embedded.upcomingInvoice.items.periodEndTime` (string) Date and time when the billing period ends. - `_embedded.upcomingInvoice.items.periodNumber` (integer) Billing period number that is associated with the invoice item. For example, an invoice item for a service is included in billing period number 3. The invoice item is only applied to billing period number 3. - `_embedded.upcomingInvoice.amount` (number) Amount of the invoice. - `_embedded.upcomingInvoice.amountDue` (number) Amount that is due on the invoice. - `_embedded.upcomingInvoice.subtotalAmount` (number) Subtotal amount of the invoice. - `_embedded.upcomingInvoice.discountAmount` (number) Discount amount that is applied to the invoice. - `_embedded.upcomingInvoice.discounts` (array) Discounts applied. - `_embedded.upcomingInvoice.discounts.couponId` (string) ID of the coupon. Example: cpn_0YVCNKF81GD778N4YNVGDJK558 - `_embedded.upcomingInvoice.discounts.amount` (number) Total amount discounted by this coupon. - `_embedded.upcomingInvoice.discounts.description` (string) Description of the discount. - `_embedded.upcomingInvoice.isNewOrder` (boolean) Specifies if the order is a new order. Example: true - `_embedded.upcomingInvoice.dueTime` (string) Date and time when the invoice is due for payment. - `_embedded.paymentInstrument` (any) - `_embedded.paymentInstrument.id` (string) ID of the payment instrument. Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N - `_embedded.paymentInstrument.method` (string, required) Method of payment instrument. Enum: "payment-card" - `_embedded.paymentInstrument.status` (string) Status of the payment instrument. An `active` status means that a payment instrument has been used at least once for an approved transaction. To remove an instrument from use, set this value to `deactivated`. For more information, see [`POST /payment-instruments/{id}/deactivation`](https://www.rebilly.com/catalog/all/payment-instruments/postpaymentinstrumentdeactivation). Enum: "active", "inactive", "expired", "deactivated", "verification-needed" - `_embedded.paymentInstrument.fingerprint` (string) Unique value that is used to identify the payment instrument. This value is generated from the `bin` and the `last4` values. This value contains alphanumeric characters. - `_embedded.paymentInstrument.bin` (string) Bank Identification Number (BIN) of the payment card. This value is the same as the first 6 digits of the associated Primary Account Number (PAN). - `_embedded.paymentInstrument.last4` (string) Last 4 digits of the associated Primary Account Number (PAN). - `_embedded.paymentInstrument.fpanLast4` (string | null) Last 4 digits of the Funding Primary Account Number (FPAN) of the payment card. This value is only present for payment cards created from digital wallet tokens, where the FPAN is the physical card number visible to the cardholder, as opposed to the Device Primary Account Number (DPAN) used in the digital wallet transaction. - `_embedded.paymentInstrument.expYear` (integer) Expiration year of the payment card. - `_embedded.paymentInstrument.expMonth` (integer) Expiration month of the payment card. - `_embedded.paymentInstrument.brand` (string) Brand of payment card. Enum: "Visa", "MasterCard", "American Express", "Discover", "Maestro", "Solo", "Electron", "JCB", "Voyager", "Diners Club", "Switch", "Laser", "China UnionPay", "AstroPay Card" - `_embedded.paymentInstrument.bankCountry` (string | null) Bank country of the payment instrument. - `_embedded.paymentInstrument.bankName` (string) Bank name of the payment instrument. - `_embedded.paymentInstrument.isPayoutable` (boolean) Specifies if payouts are supported for cards with this BIN. Defaults to `true`. This value is `false` if the BIN does not support payouts. - `_embedded.paymentInstrument.useAsBackup` (boolean) Specifies if this payment instrument can be used as a backup for invoice payment retries. - `_embedded.paymentInstrument.billingPortalUrl` (string) URL of the billing portal where the card can be updated. - `_embedded.paymentInstrument.lastPaymentTime` (string | null) Date and time of the last approved payment. Payments are the result of `sale` or `capture` transactions. - `_embedded.paymentInstrument.stickyGatewayAccountId` (string | null) ID of the sticky gateway account. All future payments are processed by this gateway account. For more information, see [Gateway routing](https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts). - `_embedded.paymentInstrument.expirationReminderTime` (string | null) Date and time when an expiration reminder event is triggered. - `_embedded.paymentInstrument.expirationReminderNumber` (integer | null) Number of expiration reminder events that have triggered. - `_embedded.paymentInstrument.referenceData` (object) Payment instrument reference data. Example: {"gatewayTransactionId":"GAT123"} - `_embedded.paymentInstrument.digitalWallet` (string | null) Digital wallet type. Enum: "Apple Pay", "Google Pay", "Samsung Pay", null - `_embedded.paymentInstrument.riskMetadata` (any) - `_embedded.paymentInstrument.revision` (integer) Number of times the payment instrument data has been modified. Use this value when analyzing webhook data to determine if a change must take precedence over the current representation. - `_embedded.paymentInstrument._links` (array) Related links. - `_embedded.paymentInstrument._links.href` (string) Link URL. - `_embedded.paymentInstrument._links.rel` (string) Type of link. Enum: "self", "customer" - `_embedded.paymentInstrument._embedded` (object) Embedded objects that are requested by the `expand` query parameter. - `_embedded.paymentInstrument._embedded.customer` (object) - `_embedded.paymentInstrument.bankName` (string) Name of the bank. - `_embedded.paymentInstrument.routingNumber` (string) Bank routing number. - `_embedded.paymentInstrument.accountNumberType` (string) Type of bank account number. A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN). Enum: "BBAN", "IBAN" - `_embedded.paymentInstrument.accountType` (string) Type of bank account. Enum: "checking", "savings", "other" - `_embedded.paymentInstrument.bic` (string | null) Bank Identifier Code (BIC). - `_embedded.paymentInstrument.fingerprint` (string) Unique value which identifies the bank account. This value contains alphanumeric characters. Depending on the type of bank account number, a bank account fingerprint is generated using one of the following: - BBAN: `last4` and `routingNumber` values. - IBAN: First 8 characters of the IBAN and the `last4` value. - `_embedded.paymentInstrument.last4` (string) Last 4 digits of the bank account number. - `_embedded.paymentInstrument.status` (string) Status of the bank account. Enum: "active", "deactivated" - `_embedded.paymentInstrument.stickyGatewayAccountId` (string | null) ID of the sticky gateway account. All future payments are processed by this gateway account. For more information, see [Gateway routing](https://www.rebilly.com/docs/settings/intelligent-payment-routing/#sticky-gateway-accounts). - `_embedded.paymentInstrument.username` (string) PayPal username. - `_embedded.paymentInstrument.status` (string) PayPal account status. Enum: "inactive", "active", "deactivated" - `_embedded.paymentInstrument.method` (string, required) Payment method of the payment instrument. Enum: "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Alfa-click", "Alipay", "AstroPay Card", "AstroPay-GO", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Boleto", "cash-deposit", "CASHlib", "CashToCode", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Cupon-de-pagos", "cryptocurrency", "domestic-cards", "Directa24Card", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "Efecty", "EPS", "ePay.bg", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Gpaysafe", "Google Pay", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "instant-bank-transfer", "InstantPayments", "Interac", "Interac-online", "Interac-eTransfer", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "loonie", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Bancontact", "Bancontact-mobile", "MTS", "Mollie", "MuchBetter", "MuchBetterVoucher", "Multibanco", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-deposit-express", "Pagsmile-lottery", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paymero", "Perfect-money", "Piastrix", "PIX", "PIX-Automatico", "plaid-account", "PayTabs", "Paysafecard", "Paysafecash", "Pay4Fun", "Paynote", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "Quickpay", "rapyd-checkout", "Resurs", "SafetyPay", "Samsung Pay", "SEPA", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "swift-dbt", "Tele2", "Terminaly-RF", "Thunes-Checkout", "ToditoCash-card", "Trustly", "Tupay", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "Viva", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "wire", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip" - `_embedded.paymentInstrument.status` (string) Payment instrument status. Enum: "active", "deactivated" - `_embedded.website` (object) - `_embedded.website.id` (string) ID of the website. A website is where an organization obtains a customer. For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG - `_embedded.website.name` (string, required) Name of the website. - `_embedded.website.url` (string, required) Domain address of the website. - `_embedded.website.servicePhone` (string, required) Customer service phone number of the website. - `_embedded.website.serviceEmail` (string, required) Customer service email address of the website. - `_embedded.website.settings` (object) Website settings. - `_embedded.website.settings.paymentForm` (object) Payment form settings. - `_embedded.website.settings.paymentForm.css` (string | null) Hosted payment form [CSS options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles). - `_embedded.website.settings.paymentForm.theme` (object | null) Hosted payment form [theme options](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style). The `pageColorBackground` property sets the background color of the page around the form. It is read by the hosted payment form page and is not passed to Rebilly Instruments. Example: {"colorPrimary":"#504CCA","pageColorBackground":"#F6F8F9"} - `_embedded.website.settings.paymentForm.features` (object | null) Hosted payment form features. - `_embedded.website.settings.paymentForm.features.showCoupons` (array | null) - `_embedded.website.settings.paymentForm.features.fullPageRedirect` (boolean | null) Specifies whether the hosted payment form uses a full page redirect, or the default iframe modal, for approval URL redirects. - `_embedded.website.settings.paymentForm.features.skipRedirectOnPaymentComplete` (boolean | null) Specifies whether the hosted payment form skips the redirect to the website URL when the payment is completed. - `_embedded.website.settings.paymentForm.features.hideZeroAmountSummaryItems` (boolean | null) Specifies if the hosted payment form displays 0 amount line items in the summary. - `_embedded.website.settings.amplitude` (object) Amplitude settings. Amplitude is an analytics tool for tracking user behavior. - `_embedded.website.settings.amplitude.tracking` (boolean) Specifies if the hosted pages, such as KYC pages, include Amplitude analytics. - `_embedded.website.settings.amplitude.apiKey` (string | null) API key of an Amplitude project. Example: 35d1795750c585984f7e6b01c0ca6e19 - `_embedded.website.settings.payoutRequest` (object) Payout request settings for the website. - `_embedded.website.settings.payoutRequest.automaticReadinessEnabled` (boolean) Specifies whether pending payout requests are automatically marked as `ready`. When this value is `false`, payout requests are created in the `ready` status and automatic transition is not used. When this value is `true`, payout requests remain in the `pending` status until the pending period elapses and the configured transition time is reached. - `_embedded.website.settings.payoutRequest.pendingPeriodHours` (integer) Minimum number of hours a payout request stays in the `pending` status before it can be automatically set to `ready`. Required when `automaticReadinessEnabled` is `true`. Example: 48 - `_embedded.website.settings.payoutRequest.automaticReadinessTime` (string) Time of day when the automatic readiness job processes eligible pending payout requests. Required when `automaticReadinessEnabled` is `true`. Use extended ISO-8601 time format (`HH:MM:SS`) with an optional timezone offset. When the timezone offset is omitted, the server timezone is used. Example: 10:00:00Z - `_embedded.website.settings.payoutRequest.automaticReadinessLastExecutedAt` (string | null) Date and time when the automatic readiness job last completed successfully for this website. - `_embedded.website.logoId` (string | null) ID of the linked file object. Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 - `_embedded.website.logoUrl` (string | null) URL of the website logo. - `_embedded.website.organizationId` (string) Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id). Example: org_0YVDM8RC7GDADADSBSMW124JA8 - `_embedded.website._links` (array) Related links. - `_embedded.website._links.href` (string) Link URL. - `_embedded.website._links.rel` (string) Type of link. Enum: "self", "logoUrl" - `billingAddress` (any) Billing address of the order. - `deliveryAddress` (any) Delivery address of the order. ## Response 201 headers (application/json): - `Location` (string) Location of the related resource. Example: https://api.rebilly.com/example - `Rate-Limit-Limit` (integer) Maximum number of requests available at one time for this rate limit. For more information, see [Rate limits](#section/Rate-limits). Example: 500 - `Rate-Limit-Remaining` (integer) Number of requests still available for this rate limit. For more information, see [Rate limits](#section/Rate-limits). Example: 499 ## Response 401: - `401` (unknown) Unauthorized access. Invalid credentials used. ## Response 401 fields (application/json): - `status` (integer) HTTP status code. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 403: - `403` (unknown) Access forbidden. If the organization requires multi-factor authentication (MFA) and the session has not passed MFA, `error` is `mfa_required`. ## Response 403 fields (application/json): - `status` (integer) HTTP status code. - `error` (string) Message that describes why the request is forbidden. Most responses use a descriptive message, such as `Not allowed to change security settings`. If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`. If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 404: - `404` (unknown) Resource not found. ## Response 404 fields (application/json): - `status` (integer) HTTP status code. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 409: - `409` (unknown) Conflict. ## Response 409 fields (application/json): - `status` (integer) HTTP status code. - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 429: - `429` (unknown) Request rate limit exceeded. ## Response 429 fields (application/json): - `type` (string) Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". Example: about:blank - `title` (string) Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem. Example: Rate Limit Exceeded - `status` (integer) HTTP status code. - `detail` (string) Human-readable explanation that is specific to this occurrence of the problem. Example: A request cannot be executed because the user has sent too many requests within a certain period of time - `instance` (string) URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. ## Response 429 headers (application/json): - `Rate-Limit-Limit` (integer) Maximum number of requests available at one time for this rate limit. For more information, see [Rate limits](#section/Rate-limits). Example: 500 - `Rate-Limit-Remaining` (integer) Number of requests still available for this rate limit. For more information, see [Rate limits](#section/Rate-limits). Example: 0 - `Rate-Limit-Retry-After` (integer) Number of seconds to wait before retrying the request. Example: 1 - `Retry-After` (integer) Number of seconds to wait before retrying the request. Example: 1